pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Introduced custom 404 page in readthedocs documentation to replace…

Browse Source
This commit is contained in:
Krzysztof Budzynski
2019-03-28 01:38:31 +08:00
parent da90966828
commit cb87e786a5
5 changed files with 785 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/documenting-code.rst
+5 -4
View File
@@ -246,10 +246,11 @@ You can setup environment to build documentation locally on your PC by installin
1. Doxygen - https://www.stack.nl/~dimitri/doxygen/
2. Sphinx - https://github.com/sphinx-doc/sphinx/#readme-for-sphinx
3. Docment theme "sphinx_rtd_theme" - https://github.com/rtfd/sphinx_rtd_theme
4. Breathe - https://github.com/michaeljones/breathe#breathe
5. Blockdiag - http://blockdiag.com/en/index.html
6. Recommonmark - https://github.com/rtfd/recommonmark
3. Breathe - https://github.com/michaeljones/breathe#breathe
4. Document theme "sphinx_rtd_theme" - https://github.com/rtfd/sphinx_rtd_theme
5. Custom 404 page "sphinx-notfound-page" - https://github.com/rtfd/sphinx-notfound-page
6. Blockdiag - http://blockdiag.com/en/index.html
7. Recommonmark - https://github.com/rtfd/recommonmark
The package "sphinx_rtd_theme" is added to have the same "look and feel" of `ESP32 Programming Guide <https://docs.espressif.com/projects/esp-idf/en/latest/index.html>`_ documentation like on the "Read the Docs" hosting site.