Ctrl+K
Logo image Logo image

Documenteer

Site Navigation

  • Project guides
  • Sphinx extensions
  • Development
  • Change Log
  • Rubin docs

Site Navigation

  • Project guides
  • Sphinx extensions
  • Development
  • Change Log
  • Rubin docs

Section Navigation

Guides

  • Development guide
  • Release procedure

Reference

  • Python API reference
    • documenteer.conf
      • get_asset_path
      • get_template_dir
      • DocumenteerConfig
      • ProjectModel
      • ConfigRoot
    • documenteer.ext
      • setup
      • filter_symbolmap
      • AutoCppApi
      • setup
    • documenteer.requestsutils
      • requests_retry_session
    • documenteer.sphinxconfig
      • build_package_configs
      • build_pipelines_lsst_io_configs
      • configure_technote
      • form_ltd_edition_name
      • get_filepaths_with_extension
      • get_project_content_commit_date
      • read_git_branch
      • read_git_commit_timestamp
      • read_git_commit_timestamp_for_file
    • documenteer.sphinxext
      • setup
      • setup
      • LsstBibtexStyle
      • jira_bracket_role
      • jira_parens_role
      • jira_role
      • setup
      • lsst_doc_shortlink_role
      • lsst_doc_shortlink_titlecase_display_role
      • lsstio_doc_shortlink_role
      • setup
      • mock_code_ref_role
      • setup
      • setup
      • ModuleTocTree
      • PackageTocTree
    • documenteer.sphinxrunner
      • run_sphinx
    • documenteer.stackdocs
      • build_stack_docs
      • preprocess_package_doxygen_conf
      • render_doxygen_mainpage
      • get_doxygen_default_conf_path
      • get_cpp_reference_tagfile_path
      • run_doxygen
      • DoxygenConfiguration
      • discover_setup_packages
      • find_table_file
      • list_packages_in_eups_table
      • find_package_docs
      • Package
      • NoPackageDocs
      • discover_package_doc_dir
      • discover_conf_py_directory

Development#

Guides

  • Development guide
    • Scope of contributions
    • Environment set up
    • Code formatting and linting with pre-commit
    • Running tests via tox
    • Running tests through pytest
    • Building documentation
    • Updating the change log
    • Style guide
  • Release procedure
    • Regular releases
    • Backport releases

Reference

  • Python API reference
    • documenteer.conf
    • documenteer.ext
    • documenteer.requestsutils
    • documenteer.sphinxconfig
    • documenteer.sphinxext
    • documenteer.sphinxrunner
    • documenteer.stackdocs

previous

The autodocreset extension for resetting automodapi’s autodoc enhancements

next

Development guide

© Copyright 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA).

Created using Sphinx 5.1.1.