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/index.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/index.rst (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3df0cae --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,35 @@ +.. Python Discord DevOps documentation master file, created by + sphinx-quickstart on Wed Jul 24 19:49:56 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Python Discord DevOps +===================== + +Welcome to the Python Discord DevOps knowledgebase. + +Within this set of pages you will find: +- Changelogs +- Post-mortems +- Common queries +- Runbooks + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + general/index + meeting_notes/index + onboarding/index + postmortems/index + queries/index + runbooks/index + tooling/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` -- cgit v1.2.3