d398a6ced2
- CitrineOS core extracted (CSMS OCPP 2.0.1) - OpenOCPP extracted (firmware OCPP 1.6J/2.0.1) - ShapeShifter library installed (pip install -e) - ShapeShifter specification extracted - EVerest extracted TODO updated with progress
38 lines
1014 B
ReStructuredText
38 lines
1014 B
ReStructuredText
.. _documenting_everest:
|
|
|
|
###################
|
|
Documenting EVerest
|
|
###################
|
|
|
|
Documentation helps beginners to start with EVerest and advanced users to
|
|
be effective by quickly having required information had hand. Find out how
|
|
to help writing and keeping documentation up to date.
|
|
|
|
.. grid:: 1 2 2 3
|
|
:gutter: 2
|
|
|
|
.. grid-item-card:: Write Documentation
|
|
:link: extending-everest-documentation
|
|
:link-type: doc
|
|
|
|
How to write documentation for EVerest. A detailed description.
|
|
|
|
.. grid-item-card:: Documenting Quickstart
|
|
:link: change-documentation-quickstart
|
|
:link-type: doc
|
|
|
|
Short description with the most important steps required to change the EVerest documentation.
|
|
|
|
.. grid-item-card:: Sphinx Style Guide
|
|
:link: sphinx-style-guide
|
|
:link-type: doc
|
|
|
|
How to achieve the desired formatting with Sphinx.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 1
|
|
|
|
extending-everest-documentation
|
|
change-documentation-quickstart
|
|
sphinx-style-guide |