Index Symbols | A | B | C | D | E | F | G | H | I | J | L | M | N | O | P | Q | R | S | T | U | V | W | X Symbols --dir package-docs command line option refresh-lsst-bib command line option 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 stack-docs-build command line option --doxygen-conf 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 --nitpicky package-docs-build command line option stack-docs-build command line option --no-escape stack-docs-listcc command line option --pattern stack-docs-listcc command line option --skip stack-docs-build command line option --skip-dox stack-docs-build command line option --type 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 --warning-is-error package-docs-build command line option stack-docs-build command line option -d package-docs command line option refresh-lsst-bib command line option stack-docs command line option -h refresh-lsst-bib command line option -n package-docs-build command line option stack-docs-build 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 -W package-docs-build command line option stack-docs-build command line option A append_extensions() (documenteer.conf.DocumenteerConfig method) append_linkcheck_ignore() (documenteer.conf.DocumenteerConfig method) append_nitpick_ignore() (documenteer.conf.DocumenteerConfig method) append_nitpick_ignore_regex() (documenteer.conf.DocumenteerConfig method) AutoCppApi (class in documenteer.ext.autocppapi) autocppapi (directive) automodapi_toctreedirm (documenteer.conf.DocumenteerConfig attribute) B base_url (documenteer.conf.DocumenteerConfig attribute) 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) ConfigRoot (class in documenteer.conf._toml) configure_technote() (in module documenteer.sphinxconfig.technoteconf) copyright (documenteer.conf.DocumenteerConfig attribute) create_subdirs (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) D disable_primary_sidebars() (documenteer.conf.DocumenteerConfig method) 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.conf module documenteer.conf._toml module documenteer.ext.autocppapi module documenteer.ext.autodocreset module documenteer.ext.openapi module 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 DocumenteerConfig (class in documenteer.conf) doxygen_conf_in_path (documenteer.stackdocs.pkgdiscovery.Package attribute) doxygen_conf_path (documenteer.stackdocs.pkgdiscovery.Package attribute) DoxygenConfiguration (class in documenteer.stackdocs.doxygen) E extend_exclude_patterns() (documenteer.conf.DocumenteerConfig method) extend_intersphinx_mapping() (documenteer.conf.DocumenteerConfig method) F filter_symbolmap() (in module documenteer.ext.autocppapi) final_argument_whitespace (documenteer.ext.autocppapi.AutoCppApi attribute) find_and_load() (documenteer.conf.DocumenteerConfig class method) 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_openapi_spec() (in module documenteer.ext.openapi) generate_xml (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) get_asset_path() (in module documenteer.conf) 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) get_template_dir() (in module documenteer.conf) github_url (documenteer.conf.DocumenteerConfig attribute) H has_content (documenteer.ext.autocppapi.AutoCppApi attribute) (documenteer.sphinxext.packagetoctree.ModuleTocTree attribute) (documenteer.sphinxext.packagetoctree.PackageTocTree attribute) header_links_before_dropdown (documenteer.conf.DocumenteerConfig attribute) I IntersphinxModel (class in documenteer.conf._toml) ittn (role) 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) LinkCheckModel (class in documenteer.conf._toml) list_packages_in_eups_table() (in module documenteer.stackdocs.pkgdiscovery) load() (documenteer.conf.DocumenteerConfig class method) 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) lsstio_doc_shortlink_role() (in module documenteer.sphinxext.lsstdocushare) 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.conf documenteer.conf._toml documenteer.ext.autocppapi documenteer.ext.autodocreset documenteer.ext.openapi 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 nitpicky (documenteer.conf.DocumenteerConfig attribute) NoPackageDocs O OpenApiDocsModel (class in documenteer.conf._toml) OpenApiGeneratorModel (class in documenteer.conf._toml) option_spec (documenteer.ext.autocppapi.AutoCppApi attribute) (documenteer.sphinxext.packagetoctree.ModuleTocTree attribute) (documenteer.sphinxext.packagetoctree.PackageTocTree attribute) optional_arguments (documenteer.ext.autocppapi.AutoCppApi attribute) P Package (class in documenteer.stackdocs.pkgdiscovery) package-docs command line option --dir --verbose --version -d -v package-docs-build command line option --nitpicky --warning-is-error -n -W 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 (documenteer.conf.DocumenteerConfig attribute) project_brief (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) project_name (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) ProjectModel (class in documenteer.conf._toml) pstn (role) Python Enhancement Proposals PEP 440, [1] PEP 484 PEP 8 PythonPackageModel (class in documenteer.conf._toml) 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 --help --verbose -d -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) required_arguments (documenteer.ext.autocppapi.AutoCppApi attribute) rst_epilog (documenteer.conf.DocumenteerConfig attribute) rst_epilog_path (documenteer.conf.DocumenteerConfig attribute) rtn (role) run() (documenteer.ext.autocppapi.AutoCppApi method) (documenteer.sphinxext.packagetoctree.ModuleTocTree method) (documenteer.sphinxext.packagetoctree.PackageTocTree method) run_doxygen() (in module documenteer.stackdocs.doxygen) run_sphinx() (in module documenteer.sphinxrunner) S set_edit_on_github() (documenteer.conf.DocumenteerConfig method) setup() (in module documenteer.ext.autocppapi) (in module documenteer.ext.autodocreset) (in module documenteer.ext.openapi) (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) sitcomtn (role) smtn (role) SphinxModel (class in documenteer.conf._toml) sqr (role) stack-docs command line option --dir --verbose --version -d -v stack-docs-build command line option --disable-doxygen --disable-doxygen-conf --disable-sphinx --disable-symlinks --dox --doxygen-conf --enable-doxygen --enable-doxygen-conf --enable-sphinx --enable-symlinks --nitpicky --skip --skip-dox --use-doxygen-conf --use-doxygen-conf-in --warning-is-error -n -s -W stack-docs-help command line option TOPIC stack-docs-listcc command line option --escape --no-escape --pattern --type -p -t T ThemeModel (class in documenteer.conf._toml) TOPIC package-docs-help command line option stack-docs-help command line option tstn (role) U use_mathjax (documenteer.stackdocs.doxygen.DoxygenConfiguration attribute) V validate_package() (documenteer.conf._toml.PythonPackageModel class method) version (documenteer.conf.DocumenteerConfig 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)