https://github.com/ruslo/read_the_docs_template

Sphinx configuration template with the Sphinx-Immaterial theme for the Read the Docs
https://github.com/ruslo/read_the_docs_template

readthedocs sphinx

Last synced: about 2 months ago
JSON representation

Sphinx configuration template with the Sphinx-Immaterial theme for the Read the Docs

• Host: GitHub
• URL: https://github.com/ruslo/read_the_docs_template
• Owner: ruslo
• License: bsd-2-clause
• Created: 2024-02-07T06:47:10.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-07-26T05:54:29.000Z (5 months ago)
• Last Synced: 2024-07-27T03:25:03.989Z (5 months ago)
• Topics: readthedocs, sphinx
• Homepage: https://read-the-docs-template-cdkwuttv.readthedocs.io/
• Size: 43.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/readme.rst
  • License: license

Awesome Lists containing this project

README

        
- ``setup_venv.py`` Setup Python virtual environment with dependencies from ``requirements.txt``

- ``run_build.py`` Build Sphinx documentation

- ``run_clean.py`` Remove temporary documentation files

- ``make_release.py`` Update ``release`` in ``conf.py`` and create Git tag

Dependencies

------------

Required system packages:

.. code-block:: none

  $ apt -y install python3-venv

  $ apt -y install python3-enchant

  $ apt -y install git