Index

Symbols

--dir <dir> refresh-lsst-bib command line option --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 --doxygen-conf <doxygen_conf_defaults_path> 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 --escape stack-docs-listcc command line option --help refresh-lsst-bib command line option --no-escape stack-docs-listcc command line option --pattern <pattern> stack-docs-listcc command line option

--skip <skip> stack-docs-build command line option --skip-dox <skip_dox> stack-docs-build command line option --type <api_types> stack-docs-listcc 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 refresh-lsst-bib 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 -d <dir> refresh-lsst-bib command line option -h refresh-lsst-bib command line option -p stack-docs-listcc command line option -s stack-docs-build command line option -t stack-docs-listcc command line option -v package-docs command line option refresh-lsst-bib command line option stack-docs command line option

A

autocppapi (directive)

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

collection (role)

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) dmtn (role) dmtr (role) document (role) documenteer.requestsutils module documenteer.sphinxconfig.stackconf module documenteer.sphinxconfig.technoteconf module documenteer.sphinxconfig.utils module documenteer.sphinxext module documenteer.sphinxext.bibtex module documenteer.sphinxext.jira module documenteer.sphinxext.lsstdocushare module

documenteer.sphinxext.mockcoderefs module documenteer.sphinxext.packagetoctree module documenteer.sphinxrunner module 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)

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)

format_docushare() (documenteer.sphinxext.bibtex.LsstBibtexStyle method) 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_cpp_reference_tagfile_path() (in module documenteer.stackdocs.doxygen) get_doxygen_default_conf_path() (in module documenteer.stackdocs.doxygen) get_filepaths_with_extension() (in module documenteer.sphinxconfig.utils) get_project_content_commit_date() (in module documenteer.sphinxconfig.utils)

H

has_content (documenteer.sphinxext.packagetoctree.ModuleTocTree attribute) (documenteer.sphinxext.packagetoctree.PackageTocTree attribute)

J

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

jira_role() (in module documenteer.sphinxext.jira) jirab (role) jirap (role)

L

lca (role) lcn (role) lcr (role) ldm (role) lep (role) list_packages_in_eups_table() (in module documenteer.stackdocs.pkgdiscovery) lpm (role) lse (role) lso (role) 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) LsstBibtexStyle (class in documenteer.sphinxext.bibtex) lsstc (role) lsstcc (role) lts (role)

M

mathjax_format (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) mathjax_relpath (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) minutes (role) mock_code_ref_role() (in module documenteer.sphinxext.mockcoderefs) module documenteer.requestsutils documenteer.sphinxconfig.stackconf documenteer.sphinxconfig.technoteconf documenteer.sphinxconfig.utils documenteer.sphinxext documenteer.sphinxext.bibtex documenteer.sphinxext.jira documenteer.sphinxext.lsstdocushare documenteer.sphinxext.mockcoderefs documenteer.sphinxext.packagetoctree documenteer.sphinxrunner documenteer.stackdocs.build documenteer.stackdocs.doxygen documenteer.stackdocs.packagecli documenteer.stackdocs.pkgdiscovery documenteer.stackdocs.rootdiscovery documenteer.stackdocs.stackcli

module-toctree (directive) ModuleTocTree (class in documenteer.sphinxext.packagetoctree)

N

NoPackageDocs

O

option_spec (documenteer.sphinxext.packagetoctree.ModuleTocTree attribute) (documenteer.sphinxext.packagetoctree.PackageTocTree attribute)

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

package-toctree (directive) PackageTocTree (class in documenteer.sphinxext.packagetoctree) preprocess_package_doxygen_conf() (in module documenteer.stackdocs.doxygen) project_brief (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) project_name (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) Python Enhancement Proposals PEP 440, [1] PEP 484 PEP 8

Q

quiet (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

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) refresh-lsst-bib command line option --dir <dir> --help --verbose -d <dir> -h -v

remote-code-block (directive) render() (documenteer.stackdocs.doxygen.DoxygenConfiguration method) render_doxygen_mainpage() (in module documenteer.stackdocs.doxygen) report (role) requests_retry_session() (in module documenteer.requestsutils) run() (documenteer.sphinxext.packagetoctree.ModuleTocTree method) (documenteer.sphinxext.packagetoctree.PackageTocTree method) 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) smtn (role) sqr (role) 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> --doxygen-conf <doxygen_conf_defaults_path> --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 stack-docs-listcc command line option --escape --no-escape --pattern <pattern> --type <api_types> -p -t

T

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

U

use_mathjax (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

W

warn_as_error (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) warn_format (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) warn_if_doc_error (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

warn_if_undocumented (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) warn_logfile (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) warn_no_paramdoc (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) warnings (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)

X

xml_programlisting (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute)