Sphinx
Prerequisites
Install python3 and pip3, see Install Python Development Environment.
Install
Edit file requirements.txt:
Sphinx
myst-parser
sphinx-copybutton
sphinx-design
sphinx-rtd-theme
sphinxcontrib-mermaid
Install the requirements:
$ pip3 install -r requirements.txt
Check the version:
$ sphinx-build --version
sphinx-build 8.1.3
Usage
In your working directory:
$ sphinx-quickstart
Edit file conf.py:
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import sys
+
+sys.path.append('.')
+
+from lasphinx import *
+
project = "Lasy's Documentation"
-copyright = '2024, Lasy'
+copyright = '%Y, Lasy'
author = 'Lasy'
+release = 'latest'
+language = 'en'
+html_logo = '_images/lasydoc.png'
+html_favicon = '_images/favicon-96x96.png'
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = []
-
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
+myst_substitutions = {
+}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = 'sphinx_rtd_theme'
+
+if html_theme == 'sphinx_rtd_theme':
+ html_css_files = ['lasyard_sphinx_rtd_theme.css']
Build html:
$ make html
Then open _build/html/index.html in your browser.