Skin ReadTheDocs from Sphinx, not just MkDocs

[wesleyboar]

What

Can mkdocs-tacc code be used to skin Sphinx?

Why

Two documentations at TACC —

• https://life-sciences-ml-at-tacc.readthedocs.io/
• https://containers-at-tacc.readthedocs.io/

— use Sphinx' ReadTheDocs theme, not MkDOcs' ReadTheDocs theme.

The software is different, but the themes looks the same.

If Not

Ask TACC teams to migrate from Sphinx to MkDocs, but featuresets and syntax are very different.

[wesleyboar]

Progress

Theme:

• https://github.com/wesleyboar/sphinx_tacc_theme

Research:

• https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/__init__.py
• https://github.com/bashtage/sphinx-material/blob/main/sphinx_material/__init__.py
• https://github.com/executablebooks/sphinx-book-theme/blob/master/src/sphinx_book_theme/__init__.py

Reference

How to Theme:

• https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
• https://www.sphinx-doc.org/en/master/development/html_themes/index.html#theme-configuration-theme-toml
• https://github.com/readthedocs/sphinx_rtd_theme

Other Themes:

• https://github.com/bashtage/sphinx-material
• https://github.com/executablebooks/sphinx-book-theme
• https://github.com/readthedocs/sphinx_rtd_theme/