A Sphinx-doc theme based on Vuepress
The author is looking for project maintainers as they do not have time to maintain the project. The project is a modern responsive theme for python’s Sphinx documentation generator called “sphinx_press_theme.” The theme is still in BETA and is based on VuePress.
To install the theme, first, you need to determine the compatibility with your Sphinx version. Here is the compatibility chart:
Sphinx version compatibility
Sphinx | Press Theme
---------|-----------
4.X | latest
3.X | 0.6.1
2.X | 0.5.1
Once you have determined the compatibility, you can set the theme name to “press” in your Sphinx project’s conf.py file. You can find more detailed instructions on configuration in the documentation.
To develop the theme, you need to build the web assets. The Sphinx theme has a soft link to the built assets. Additionally, you can install the theme locally using pip install -e ... The theme’s own documentation can be found in the docs folder.
To release a new version, you need to set the version in setup.py and __init__.py files. The theme’s configuration can be found in the docs/source/conf.py file.
The sphinx_press_theme is a modern responsive theme for Python’s Sphinx documentation generator. It is based on VuePress, uses Vue.js & Stylus managed by Vite, and is still in BETA. The theme can be installed by setting it up in the Sphinx project’s conf.py file and building the necessary web assets. The theme is open for contributions, and the author is looking for project maintainers.