Sphinx

Installation

- Phyton instalieren (3.10)

https://www.python.org/downloads/

- Anpassungen:

- Pfadkürzung auf: C:/Python310

- Tick bei „…enviroment variables“

Virtuelle Enviroments

Einmalig Einrichten

cd C:\home\dokus\peter
py -m venv env

Aktivieren: Immer vor Arbeitsstart!!!! Beachte geänderte Prompt!!!! (env)

Aktivieren

cd C:\home\dokus\leon
.\env\Scripts\activate.bat

Dokumentation mit Sphinx

pip install sphinx
pip install sphinx-autobuild
pip install furo

manuelle Version

make html

automatische Übersetzung

.\env\Scripts\sphinx-autobuild source build

Konfiguration

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'MeineDoku'
copyright = '2022, Leon'
html_title = ''
author = 'Leon'
release = '1'
html_logo = '_static/meinlogo.png'
html_favicon = '_static/meinlogo.png'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    'sphinx_copybutton',
    'sphinx_togglebutton',
    'rst2pdf.pdfbuilder'
]
templates_path = ['_templates']
exclude_patterns = []

language = 'de'

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'furo'
#html_theme = 'alabaster'


html_static_path = ['_static']