Getting Started

Installation

Install using pip

pip install sphinx-gha

or by adding it as a documentation dependency for your python project

pyproject.toml

[project.optional-dependencies]
docs = [
    "sphinx-gha",
]

Configuration

sphinx_gha_repo_slug

Required Config Value

The slug to use for usage examples, in the form username/repo.

Example

sphinx_gha_repo_slug = 'drewcassidy/sphinx-gha'

sphinx_gha_repo_ref

Default:: sphinx_gha.git_ref.get_git_ref()

The current git ref to use in examples

By default this is calculated using the current git repo and/or ReadTheDocs builder environment variables. You hopefully do not need to override this.

sphinx_gha_repo_root

Default:: os.cwd()

The root of you repository, used to calculate the relative path of action/workflow files

You can set this relative to your conf.py using the python __file__ dunder variable

Example

sphinx_gha_repo_root = str(Path(__file__).parent.parent.absolute())  # docs/..

Usage

Document your actions and workflows using the gha:action and gha:workflow directives