Skip to main content
Ctrl+K

ComPWA policy

  • Common Partial Wave Analysis
  • GitHub
  • check-dev-files
  • API
    • check_dev_files
      • pixi
      • binder
      • black
      • citation
      • commitlint
      • conda
      • cspell
      • dependabot
      • deprecated
      • direnv
      • editorconfig
      • github_labels
      • github_workflows
      • gitpod
      • jupyter
      • mypy
      • nbstripout
      • precommit
      • prettier
      • pyproject
      • pyright
      • pytest
      • pyupgrade
      • readthedocs
      • release_drafter
      • ruff
      • toml
      • tox
      • update_lock
      • uv
      • vscode
    • utilities
      • precommit
        • getters
        • setters
        • struct
      • pyproject
        • getters
        • setters
      • cfg
      • executor
      • match
      • notebook
      • python
      • readme
      • toml
      • vscode
      • yaml
    • colab_toc_visible
    • errors
    • fix_nbformat_version
    • remove_empty_tags
    • self_check
    • set_nb_cells
    • set_nb_display_name
  • Changelog
  • Upcoming features
  • Help developing
  • Repository
  • Show source
  • Suggest edit
  • Open issue

readthedocs

Contents

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

readthedocs#

import compwa_policy.check_dev_files.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

pyupgrade

next

release_drafter

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

By Common Partial Wave Analysis

Last updated on 18 February 2025.