mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 08:55:15 +00:00
86639b9437
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>
20 lines
832 B
ReStructuredText
20 lines
832 B
ReStructuredText
..
|
|
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>`_.
|