From a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Wed, 24 Jul 2024 20:09:42 +0200 Subject: Improve documentation This commit ports our documentation to Sphinx. The reason for this is straightforward. We need to improve both the quality and the accessibility of our documentation. Hugo is not capable of doing this, as its primary output format is HTML. Sphinx builds plenty of high-quality output formats out of the box, and incentivizes writing good documentation. --- docs/README.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 docs/README.md (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index eaef124..0000000 --- a/docs/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# DevOps documentation - -This directory houses our DevOps documentation, written using -[Hugo](https://gohugo.io). - -To test changes to it locally, run `hugo serve` and follow the link displayed -on your Terminal. To generate all files, just run `hugo`. - - -- cgit v1.2.3