API Reference

docs_helper.py

Small script that makes it easier to work with intersphinx it takes config data from docs/conf.py

Cross-referencing syntax

insted of: python -m sphinx.ext.intersphinx https://www.sphinx-doc.org/en/master/objects.inv
run python scripts/docs_helper.py.py and then pick the project you want.

Wraps also over sphobjinv to make easy to search

We don’t need to use edit sys.path and and then to import

We only use importlib.util

Todo

set chmod on env file like ssh does to keys

autofix shorthand https://github.com/bskinn/sphobjinv/issues/234

Note

idea make it a sphinx plugin to autofix the setup and extract build_dir

docs_helper.main()[source]
docs_helper.get_py_config(path: Union[Path, str])[source]

Imports the sphinx to extract the intersphinx mapping

Uses importlib.util tricks to import without the problems of edit sys.path and python lint missing imports

Note

This function will execute the input file

from: https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly

docs_helper.find_bild_dir()[source]

Support only Makefile for now

Per sphinx ref there are https://www.sphinx-doc.org/en/master/man/sphinx-build.html#environment-variables

Todo

support for make.bat and ENV