documenteer.stackdocs¶

documenteer.stackdocs.build Module¶

Stack documentation build system.

build_stack_docs(root_project_dir[, ...])

Build stack Sphinx documentation (main entrypoint).

Configuration and execution of Doxygen at the stack level.

`preprocess_package_doxygen_conf`(*, conf, package)	Preprocess a Doxygen configuration for an individual package that is based on a package's `doxygen.conf.in` file.
`render_doxygen_mainpage`()	Render the mainpage.dox page that provides content for the Doxygen subsite's homepage.
`get_doxygen_default_conf_path`()	Get the path to the doxygen configuration file included with Documenteer.
`get_cpp_reference_tagfile_path`()	Get the path to the Doxygen tag file for cppreference.com that's included with Documenteer.
`run_doxygen`(*, conf, root_dir)	Run Doxygen.

A restricted Doxygen configuration.

Implements the package-docs CLI for single-package documentation builds in the LSST Stack.

Utilities for discovering packages in a stack and discovering attributes and their documentation.

`discover_setup_packages`([scope])	Summarize packages currently set up by EUPS, listing their set up directories and EUPS version names.
`find_table_file`(root_project_dir)	Find the EUPS table file for a project.
`list_packages_in_eups_table`(table_text)	List the names of packages that are required by an EUPS table file.
`find_package_docs`(package_dir[, skipped_names])	Find documentation directories in a package using `manifest.yaml` and heuristics.

`Package`(root_dir, doc_dir[, package_dirs, ...])	Metadata about a stack package's documentation content.
`NoPackageDocs`	Exception raised when documentation is not found for an EUPS package.

Utilities for detecting the root directory of Sphinx documentation.

`discover_package_doc_dir`(initial_dir)	Discover the `doc/` dir of a package given an initial directory.
`discover_conf_py_directory`(initial_dir)	Discover the directory containing the conf.py file.

Implements the stack-docs CLI for stack documentation builds.