documenteer.sphinxconfig

documenteer.sphinxconfig.stackconf Module

Sphinx configuration defaults for LSST Stack packages.

Notes

Some configurations based on astropy-helpers astropy/astropy-helpers see licenses/astropy-helpers.txt

Functions

build_package_configs(project_name[, ...])	Builds a dict of Sphinx configurations useful for the doc/conf.py files of individual LSST Stack packages.
build_pipelines_lsst_io_configs(*, project_name)	Build a dict of Sphinx configurations that populate the conf.py of the main pipelines_lsst_io Sphinx project for LSST Science Pipelines documentation.

documenteer.sphinxconfig.utils Module

Utilities for sphinx configuration.

Functions

form_ltd_edition_name([git_ref_name])	Form the LSST the Docs edition name for this branch, using the same logic as LTD Keeper does for transforming branch names into edition names.
get_filepaths_with_extension(extname[, root_dir])	Get relative filepaths of files in a directory, and sub-directories, with the given extension.
get_project_content_commit_date([root_dir, ...])	Get the datetime for the most recent commit to a project that affected Sphinx content.
read_git_branch()	Obtain the current branch name from the Git repository.
read_git_commit_timestamp([repo_path])	Obtain the timestamp from the current head commit of a Git repository.
read_git_commit_timestamp_for_file(filepath)	Obtain the timestamp for the most recent commit to a given file in a Git repository.