Skip to main content
Ctrl+K

Documenteer

  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
    • Rubin docs
  • GitHub
  • Rubin user guides
  • Technical notes
  • Sphinx extensions
  • Change Log
  • Development
  • Rubin docs
  • GitHub

Section Navigation

Guides

  • Development guide
  • Release procedure

Architecture

  • Theming architecture overview
    • Handling CSS, JavaScript, and image assets
    • Handling Jinja HTML templates

Reference

  • Python API
    • documenteer.conf
      • get_asset_path
      • extend_static_paths_with_asset_extension
      • extend_excludes_for_non_index_source
      • get_template_dir
      • DocumenteerConfig
      • ConfigRoot
      • ProjectModel
      • PythonPackageModel
      • OpenApiDocsModel
      • OpenApiGeneratorModel
      • SphinxModel
      • IntersphinxModel
      • LinkCheckModel
      • ThemeModel
    • documenteer.ext
      • setup
      • setup
      • setup
      • setup
      • setup
      • setup
      • setup
      • generate_robots_txt
      • setup
  • Development
  • Python API

Python API#

  • documenteer.conf
    • get_asset_path
    • extend_static_paths_with_asset_extension
    • extend_excludes_for_non_index_source
    • get_template_dir
    • DocumenteerConfig
    • ConfigRoot
    • ProjectModel
    • PythonPackageModel
    • OpenApiDocsModel
    • OpenApiGeneratorModel
    • SphinxModel
    • IntersphinxModel
    • LinkCheckModel
    • ThemeModel
  • documenteer.ext
    • setup
    • setup
    • setup
    • setup
    • setup
    • setup
    • setup
    • generate_robots_txt
    • setup

previous

Handling Jinja HTML templates

next

documenteer.conf
Edit on GitHub

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

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.