Python API reference

• documenteer.conf
  • documenteer.conf Package
    • Functions
      • get_asset_path
        • get_asset_path()
      • get_template_dir
        • get_template_dir()
    • Classes
      • DocumenteerConfig
        • DocumenteerConfig
          • DocumenteerConfig.automodapi_toctreedirm
          • DocumenteerConfig.base_url
          • DocumenteerConfig.copyright
          • DocumenteerConfig.github_url
          • DocumenteerConfig.header_links_before_dropdown
          • DocumenteerConfig.nitpicky
          • DocumenteerConfig.project
          • DocumenteerConfig.rst_epilog
          • DocumenteerConfig.rst_epilog_path
          • DocumenteerConfig.version
          • DocumenteerConfig.append_extensions()
          • DocumenteerConfig.append_linkcheck_ignore()
          • DocumenteerConfig.append_nitpick_ignore()
          • DocumenteerConfig.append_nitpick_ignore_regex()
          • DocumenteerConfig.disable_primary_sidebars()
          • DocumenteerConfig.extend_exclude_patterns()
          • DocumenteerConfig.extend_intersphinx_mapping()
          • DocumenteerConfig.find_and_load()
          • DocumenteerConfig.load()
          • DocumenteerConfig.set_edit_on_github()
    • Class Inheritance Diagram
  • documenteer.conf._toml Module
    • Classes
      • ConfigRoot
        • ConfigRoot
      • ProjectModel
        • ProjectModel
      • PythonPackageModel
        • PythonPackageModel
      • OpenApiDocsModel
        • OpenApiDocsModel
      • OpenApiGeneratorModel
        • OpenApiGeneratorModel
      • SphinxModel
        • SphinxModel
      • IntersphinxModel
        • IntersphinxModel
      • LinkCheckModel
        • LinkCheckModel
      • ThemeModel
        • ThemeModel
    • Class Inheritance Diagram
• documenteer.ext
  • documenteer.ext.autocppapi Module
    • Functions
      • setup
        • setup()
      • filter_symbolmap
        • filter_symbolmap()
    • Classes
      • AutoCppApi
        • AutoCppApi
          • AutoCppApi.final_argument_whitespace
          • AutoCppApi.has_content
          • AutoCppApi.option_spec
          • AutoCppApi.optional_arguments
          • AutoCppApi.required_arguments
          • AutoCppApi.run()
    • Class Inheritance Diagram
  • documenteer.ext.autodocreset Module
    • Functions
      • setup
        • setup()
  • documenteer.ext.openapi Module
    • Functions
      • setup
        • setup()
      • generate_openapi_spec
        • generate_openapi_spec()
• documenteer.requestsutils
  • documenteer.requestsutils Module
    • Functions
      • requests_retry_session
        • requests_retry_session()
• documenteer.sphinxconfig
  • documenteer.sphinxconfig.stackconf Module
    • Functions
      • build_package_configs
        • build_package_configs()
      • build_pipelines_lsst_io_configs
        • build_pipelines_lsst_io_configs()
  • documenteer.sphinxconfig.utils Module
    • Functions
      • form_ltd_edition_name
        • form_ltd_edition_name()
      • get_filepaths_with_extension
        • get_filepaths_with_extension()
      • get_project_content_commit_date
        • get_project_content_commit_date()
      • read_git_branch
        • read_git_branch()
      • read_git_commit_timestamp
        • read_git_commit_timestamp()
      • read_git_commit_timestamp_for_file
        • read_git_commit_timestamp_for_file()
• documenteer.sphinxext
  • documenteer.sphinxext Package
    • Functions
      • setup
        • setup()
  • documenteer.sphinxext.bibtex Module
    • Functions
      • setup
        • setup()
    • Classes
      • LsstBibtexStyle
        • LsstBibtexStyle
          • LsstBibtexStyle.format_docushare()
  • documenteer.sphinxext.jira Module
    • Functions
      • jira_bracket_role
        • jira_bracket_role()
      • jira_parens_role
        • jira_parens_role()
      • jira_role
        • jira_role()
      • setup
        • setup()
  • documenteer.sphinxext.lsstdocushare Module
    • Functions
      • lsst_doc_shortlink_role
        • lsst_doc_shortlink_role()
      • lsst_doc_shortlink_titlecase_display_role
        • lsst_doc_shortlink_titlecase_display_role()
      • lsstio_doc_shortlink_role
        • lsstio_doc_shortlink_role()
      • setup
        • setup()
  • documenteer.sphinxext.mockcoderefs Module
    • Functions
      • mock_code_ref_role
        • mock_code_ref_role()
      • setup
        • setup()
  • documenteer.sphinxext.packagetoctree Module
    • Functions
      • setup
        • setup()
    • Classes
      • ModuleTocTree
        • ModuleTocTree
          • ModuleTocTree.has_content
          • ModuleTocTree.option_spec
          • ModuleTocTree.run()
      • PackageTocTree
        • PackageTocTree
          • PackageTocTree.has_content
          • PackageTocTree.option_spec
          • PackageTocTree.run()
• documenteer.sphinxrunner
  • documenteer.sphinxrunner Module
    • Functions
      • run_sphinx
        • run_sphinx()
• documenteer.stackdocs
  • documenteer.stackdocs.build Module
    • Functions
      • build_stack_docs
        • build_stack_docs()
  • documenteer.stackdocs.doxygen Module
    • Functions
      • preprocess_package_doxygen_conf
        • preprocess_package_doxygen_conf()
      • render_doxygen_mainpage
        • render_doxygen_mainpage()
      • get_doxygen_default_conf_path
        • get_doxygen_default_conf_path()
      • get_cpp_reference_tagfile_path
        • get_cpp_reference_tagfile_path()
      • run_doxygen
        • run_doxygen()
    • Classes
      • DoxygenConfiguration
        • DoxygenConfiguration
          • DoxygenConfiguration.create_subdirs
          • DoxygenConfiguration.full_path_names
          • DoxygenConfiguration.generate_html
          • DoxygenConfiguration.generate_latex
          • DoxygenConfiguration.generate_xml
          • DoxygenConfiguration.mathjax_format
          • DoxygenConfiguration.mathjax_relpath
          • DoxygenConfiguration.project_brief
          • DoxygenConfiguration.project_name
          • DoxygenConfiguration.quiet
          • DoxygenConfiguration.recursive
          • DoxygenConfiguration.use_mathjax
          • DoxygenConfiguration.warn_as_error
          • DoxygenConfiguration.warn_format
          • DoxygenConfiguration.warn_if_doc_error
          • DoxygenConfiguration.warn_if_undocumented
          • DoxygenConfiguration.warn_logfile
          • DoxygenConfiguration.warn_no_paramdoc
          • DoxygenConfiguration.warnings
          • DoxygenConfiguration.xml_programlisting
          • DoxygenConfiguration.from_doxygen_conf()
          • DoxygenConfiguration.render()
  • documenteer.stackdocs.packagecli Module
  • documenteer.stackdocs.pkgdiscovery Module
    • Functions
      • discover_setup_packages
        • discover_setup_packages()
      • find_table_file
        • find_table_file()
      • list_packages_in_eups_table
        • list_packages_in_eups_table()
      • find_package_docs
        • find_package_docs()
    • Classes
      • Package
        • Package
          • Package.doxygen_conf_in_path
          • Package.doxygen_conf_path
      • NoPackageDocs
        • NoPackageDocs
  • documenteer.stackdocs.rootdiscovery Module
    • Functions
      • discover_package_doc_dir
        • discover_package_doc_dir()
      • discover_conf_py_directory
        • discover_conf_py_directory()
  • documenteer.stackdocs.stackcli Module