Skip to main content
Ctrl+K

ComPWA policy

  • Common Partial Wave Analysis
  • GitHub
  • check-dev-files
  • API
    • cli
      • env
      • format
      • github
      • migrate
      • nb
      • python
      • repo
    • env
      • pixi
      • conda
      • direnv
      • uv
    • format
      • cspell
      • editorconfig
      • precommit
      • prettier
      • toml
    • github
      • dependabot
      • labels
      • release_drafter
      • upgrade_lock
      • workflows
    • nb
      • binder
      • jupyter
      • nbstripout
    • python
      • black
      • mypy
      • pyproject
      • pyright
      • pytest
      • pyupgrade
      • ruff
      • ty
    • repo
      • citation
      • commitlint
      • deprecated
      • gitpod
      • poe
      • readthedocs
      • vscode
    • utilities
      • precommit
        • getters
        • setters
        • struct
      • pyproject
        • getters
        • setters
      • cfg
      • executor
      • match
      • python
      • readme
      • toml
      • vscode
      • yaml
    • config
    • errors
    • self_check
  • Changelog
  • Upcoming features
  • Help developing
  • Repository
  • Show source
  • Suggest edit
  • Open issue

readthedocs

Contents

  • main()
  • ReadTheDocs
    • ReadTheDocs.dump()
    • ReadTheDocs.finalize()

readthedocs#

import compwa_policy.repo.readthedocs

Update Read the Docs configuration.

main(package_manager: PackageManagerChoice, python_version: PythonVersion, source: IO | Path | str = PosixPath('.readthedocs.yml')) → None[source]#
class ReadTheDocs(source: IO | Path | str)[source]#

Bases: object

dump(target: IO | Path | str | None = None) → None[source]#
finalize() → None[source]#

previous

poe

next

vscode

Contents
  • main()
  • ReadTheDocs
    • ReadTheDocs.dump()
    • ReadTheDocs.finalize()

By Common Partial Wave Analysis

Last updated on 22 June 2026.