1
0
Fork 0
mirror of https://github.com/anrieff/libcpuid synced 2025-07-02 14:04:15 +00:00

Document the Python bindings using Sphinx

Additionally, setup the documentation for
deployment to Read The Docs.
This commit is contained in:
Pavol Žáčik 2024-07-23 18:04:47 +02:00 committed by The Tumultuous Unicorn Of Darkness
parent 40e2d5fcb6
commit ec938b5d42
15 changed files with 226 additions and 1 deletions

35
python/docs/conf.py Normal file
View file

@ -0,0 +1,35 @@
# 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
import os
import sys
sys.path.insert(0, os.path.abspath("../src"))
project = "libcpuid"
copyright = "2024, Pavol Žáčik"
author = "Pavol Žáčik"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx_rtd_theme",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
language = "en"
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_rtd_theme"
autodoc_member_order = "bysource"