Theme evaluation

Important features

• Multiproject: The four projects tentacle, octoprobe, testbed_micropython and testbed_showcase should integrate nicely.

• Full toctree: In the flask theme, the toctree is not visible in full glory: Just chapter forward/backward. However, the full toctree is easier to navigate.

Themes

Note

Winner of the evaluation: `sphinx_rtd_theme`.

• It is reasonable to use the same as MicroPython.

• Multiproject implementation is a bit complex but doable.

sphinx_rtd_theme

• sphinx-rtd-theme

• https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html

• https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/conf.py

  • Simple classical view

  • Full hierachy visible on the left

• MicroPython

• https://docs.micropython.org/en/latest/

• https://github.com/micropython/micropython/blob/master/docs/conf.py

pallets_sphinx_themes

• flask

  • https://flask.palletsprojects.com/en/stable/

  • https://github.com/pallets/flask/blob/main/docs/conf.py

furo

• pillow

  • https://pillow.readthedocs.io/en/stable/

  • https://github.com/python-pillow/Pillow/blob/main/docs/conf.py

pydata-sphinx-theme

• examples

  • https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/gallery.html

  • https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/conf.py

    • Nice entry page with images

    • Too complex GUI: left, top, right

• https://docs.jupyter.org/en/latest/

  • https://github.com/jupyter/jupyter/blob/master/docs/source/conf.py

• https://sphinx-book-theme.readthedocs.io/en/stable/index.html

• https://sphinx-book-theme.readthedocs.io/en/stable/index.html

• https://github.com/executablebooks/sphinx-book-theme/blob/master/docs/conf.py

  • Nice documentation

sphinx-multiproject

• https://sphinx-multiproject.readthedocs.io/en/latest/