Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-12-21 10:56:19 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Add documentation infrastructure

Browse Source 
Add documentation infrastructure and some sample content.

Documentation is generated by sphinx using extensions to support
Markdown an restructuredText for simple documentation writing.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
This commit is contained in:
Bobby Noelte
2024-10-10 08:33:21 +02:00
committed by Andreas
parent 12c9e4428e
commit 86639b9437
10 changed files with 237 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/welcome.rst Normal file
View File

@@ -0,0 +1,19 @@
..
Copyright (c) 2024 Bobby Noelte
SPDX-License-Identifier: Apache-2.0
.. _akkudoktoreos_welcome:
Welcome to the EOS documentation!
#################################
This documentation is continuously written. It is edited via text files in the
`reStructuredText(reST) <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
markup language and then compiled into a static website/offline document using the open source tool
`Sphinx <https://www.sphinx-doc.org>`_ and will hopefully someday land on
`Read the Docs <https://akkudoktoreos.readthedocs.io/en/latest/index.html>`_.
You can contribute to EOS's documentation by opening
`GitHub issues <https://github.com/Akkudoktor-EOS/EOS/issues>`_
or sending patches via pull requests on its
`GitHub repository <https://github.com/Akkudoktor-EOS/EOS>`_.