From b7aee74c5be1fb86bc1ddeddcc270f4e00462d45 Mon Sep 17 00:00:00 2001 From: Nicolas Date: Thu, 22 May 2025 17:55:12 +0200 Subject: [PATCH] docs added --- .github/workflows/docs.yml | 37 ++++++++++++++++++ .gitignore | 4 +- docs/Makefile | 20 ++++++++++ docs/make.bat | 35 +++++++++++++++++ docs/source/conf.py | 32 ++++++++++++++++ docs/source/generate_class_list.py | 61 ++++++++++++++++++++++++++++++ docs/source/index.md | 10 +++++ docs/source/readme.md | 2 + 8 files changed, 200 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/generate_class_list.py create mode 100644 docs/source/index.md create mode 100644 docs/source/readme.md diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..e879bee --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,37 @@ +name: Build and Deploy Docs + +on: + push: + branches: + - main + +permissions: + contents: write + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: "3.x" + - name: Install dependencies + run: pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints myst-parser + - name: Generate Class List + run: | + pip install . + python ./docs/source/generate_class_list.py + - name: Build Docs + run: | + cd docs + sphinx-apidoc -o ./source/ ../src/ -M --no-toc + rm ./source/*.rst + make html + touch ./build/html/.nojekyll + - name: Deploy to GitHub Pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: docs/build/html diff --git a/.gitignore b/.gitignore index 5978c2e..ef5ccc4 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,6 @@ __pycache__ .vscode .mypy_cache .pytest_cache -tests/autogenerated_*.py \ No newline at end of file +tests/autogenerated_*.py +docs/build/ +docs/source/modules.md \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..4187ecf --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,32 @@ +# 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 = 'gaspype' +copyright = '2025, Nicolas Kruse' +author = 'Nicolas Kruse' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_autodoc_typehints", "myst_parser"] + +templates_path = ['_templates'] +exclude_patterns = [] + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +# html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] + +autodoc_inherit_docstrings = True diff --git a/docs/source/generate_class_list.py b/docs/source/generate_class_list.py new file mode 100644 index 0000000..8fa77cf --- /dev/null +++ b/docs/source/generate_class_list.py @@ -0,0 +1,61 @@ +import importlib +import inspect +import fnmatch +from io import TextIOWrapper + + +def write_classes(f: TextIOWrapper, patterns: list[str], module_name: str, title: str, description: str = '', exclude: list[str] = []) -> None: + + module = importlib.import_module(module_name) + + classes = [ + name for name, obj in inspect.getmembers(module, inspect.isclass) + if (obj.__module__ == module_name and + any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude) and + obj.__doc__ and '(Automatic generated stub)' not in obj.__doc__) + ] + + """Write the classes to the file.""" + f.write(f'## {title}\n\n') + if description: + f.write(f'{description}\n\n') + + for cls in classes: + f.write('```{eval-rst}\n') + f.write(f'.. autoclass:: {module_name}.{cls}\n') + f.write(' :members:\n') + f.write(' :class-doc-from: both\n') + f.write(' :undoc-members:\n') + f.write(' :show-inheritance:\n') + f.write(' :inherited-members:\n') + if title != 'Base classes': + f.write(' :exclude-members: select\n') + f.write('```\n\n') + + +def write_functions(f: TextIOWrapper, patterns: list[str], module_name: str, title: str, description: str = '', exclude: list[str] = []) -> None: + + module = importlib.import_module(module_name) + + functions = [ + name for name, obj in inspect.getmembers(module, inspect.isfunction) + if (obj.__module__ == module_name and + any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude)) + ] + + """Write the classes to the file.""" + f.write(f'## {title}\n\n') + if description: + f.write(f'{description}\n\n') + + for func in functions: + if not func.startswith('_'): + f.write('```{eval-rst}\n') + f.write(f'.. autofunction:: {module_name}.{func}\n') + f.write('```\n\n') + + +with open('docs/source/modules.md', 'w') as f: + f.write('# Functions and classes\n\n') + write_classes(f, ['*'], 'gaspype', title='Classes') + write_functions(f, ['*'], 'gaspype', title='Functions') diff --git a/docs/source/index.md b/docs/source/index.md new file mode 100644 index 0000000..7232e27 --- /dev/null +++ b/docs/source/index.md @@ -0,0 +1,10 @@ +```{toctree} +:maxdepth: 2 +:caption: Contents: + +readme +modules +``` + +```{include} ../../README.md +``` \ No newline at end of file diff --git a/docs/source/readme.md b/docs/source/readme.md new file mode 100644 index 0000000..060259b --- /dev/null +++ b/docs/source/readme.md @@ -0,0 +1,2 @@ +```{include} ../../README.md +``` \ No newline at end of file