Index

Symbols

--dir <root_dir> package-docs command line option --dir <root_project_dir> stack-docs command line option --disable-doxygen stack-docs-build command line option --disable-doxygen-conf stack-docs-build command line option --disable-sphinx stack-docs-build command line option --disable-symlinks stack-docs-build command line option --dox <dox> stack-docs-build command line option --enable-doxygen stack-docs-build command line option --enable-doxygen-conf stack-docs-build command line option --enable-sphinx stack-docs-build command line option --enable-symlinks stack-docs-build command line option

--skip <skip> stack-docs-build command line option --skip-dox <skip_dox> stack-docs-build command line option --use-doxygen-conf stack-docs-build command line option --use-doxygen-conf-in stack-docs-build command line option --verbose package-docs command line option stack-docs command line option --version package-docs command line option stack-docs command line option -d package-docs command line option stack-docs command line option -s stack-docs-build command line option -v package-docs command line option stack-docs command line option

B

build_package_configs() (in module documenteer.sphinxconfig.stackconf)

build_pipelines_lsst_io_configs() (in module documenteer.sphinxconfig.stackconf) build_stack_docs() (in module documenteer.stackdocs.build)

C

configure_technote() (in module documenteer.sphinxconfig.technoteconf)

create_subdirs (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

D

discover_conf_py_directory() (in module documenteer.stackdocs.rootdiscovery) discover_package_doc_dir() (in module documenteer.stackdocs.rootdiscovery) discover_setup_packages() (in module documenteer.stackdocs.pkgdiscovery) documenteer.stackdocs.build (module) documenteer.stackdocs.doxygen (module) documenteer.stackdocs.packagecli (module)

documenteer.stackdocs.pkgdiscovery (module) documenteer.stackdocs.rootdiscovery (module) documenteer.stackdocs.stackcli (module) doxygen_conf_in_path (documenteer.stackdocs.pkgdiscovery.Package attribute) doxygen_conf_path (documenteer.stackdocs.pkgdiscovery.Package attribute) DoxygenConfiguration (class in documenteer.stackdocs.doxygen)

E

enable_preprocessing (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

expand_only_predef (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

F

find_package_docs() (in module documenteer.stackdocs.pkgdiscovery) find_table_file() (in module documenteer.stackdocs.pkgdiscovery)

form_ltd_edition_name() (in module documenteer.sphinxconfig.utils) from_doxygen_conf() (documenteer.stackdocs.doxygen.DoxygenConfiguration class method) full_path_names (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

G

generate_html (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) generate_latex (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

generate_xml (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) get_filepaths_with_extension() (in module documenteer.sphinxconfig.utils) get_project_content_commit_date() (in module documenteer.sphinxconfig.utils)

J

jira_bracket_role() (in module documenteer.sphinxext.jira)

jira_parens_role() (in module documenteer.sphinxext.jira) jira_role() (in module documenteer.sphinxext.jira)

L

list_packages_in_eups_table() (in module documenteer.stackdocs.pkgdiscovery) lsst-cmdlinetasks (directive) lsst-config (role) lsst-config-field (role) lsst-config-fields (directive) lsst-config-topic (directive) lsst-configs (directive) lsst-configurables (directive)

lsst-pipelinetasks (directive) lsst-task (role) lsst-task-api-summary (directive) lsst-task-config-fields (directive) lsst-task-config-subtasks (directive) lsst-task-topic (directive) lsst-tasks (directive) lsst_doc_shortlink_role() (in module documenteer.sphinxext.lsstdocushare) lsst_doc_shortlink_titlecase_display_role() (in module documenteer.sphinxext.lsstdocushare)

M

macro_expansion (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

mock_code_ref_role() (in module documenteer.sphinxext.mockcoderefs)

N

NoPackageDocs

P

Package (class in documenteer.stackdocs.pkgdiscovery) package-docs command line option --dir <root_dir> --verbose --version -d -v

package-docs-help command line option TOPIC preprocess_package_doxygen_conf() (in module documenteer.stackdocs.doxygen)

R

read_git_branch() (in module documenteer.sphinxconfig.utils) read_git_commit_timestamp() (in module documenteer.sphinxconfig.utils) read_git_commit_timestamp_for_file() (in module documenteer.sphinxconfig.utils) recursive (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

render() (documenteer.stackdocs.doxygen.DoxygenConfiguration method) requests_retry_session() (in module documenteer.requestsutils) run_doxygen() (in module documenteer.stackdocs.doxygen) run_sphinx() (in module documenteer.sphinxrunner)

S

setup() (in module documenteer.sphinxext) (in module documenteer.sphinxext.bibtex) (in module documenteer.sphinxext.jira) (in module documenteer.sphinxext.lsstdocushare) (in module documenteer.sphinxext.mockcoderefs) (in module documenteer.sphinxext.packagetoctree) skip_function_macros (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) stack-docs command line option --dir <root_project_dir> --verbose --version -d -v stack-docs-build command line option --disable-doxygen --disable-doxygen-conf --disable-sphinx --disable-symlinks --dox <dox> --enable-doxygen --enable-doxygen-conf --enable-sphinx --enable-symlinks --skip <skip> --skip-dox <skip_dox> --use-doxygen-conf --use-doxygen-conf-in -s

stack-docs-help command line option TOPIC

T

TOPIC package-docs-help command line option stack-docs-help command line option

X

xml_programlisting (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)