Update the documentation
All documentation is found in the /docs
directory.
If you need to create a new entry, add the new document in markdown (
.md
extension) to the corresponding folder. Otherwise, just edit the corresponding file.
Make sure the document has one single
# header
, otherwise they will be considered different documents.
If a new folder is added, add it to the
toctree
insidedocs/source/index.rst
(as theperipherals
folder is)Commit and push
Once the branch is merged into the main branch of X-HEEP, anyone can open a terminal in the docs folder and run
make clean html
Wait a few minutes and enjoy your brand new documentation in Read the Docs.
Thank you for helping keep X-HEEP accurately and extensively documented!