sphinx-versioned-docs 1.1

Sphinx extension to build versionsed docs.

Sphinx extension that allows building versioned docs for self-hosting. Supported on Linux and macOS.

It works by producing docs for all(specified) branches in separate folders and injects a readthedocs-like version selector menu/badge.

This project is a fork of Smile-SA/sphinx-versions with significant changes.

Get started using the documentation

How to use

sphinx-versioned --help

 Usage: sphinx-versioned [OPTIONS]

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --chdir                            TEXT  Make this the current working directory before running. [default: None]             │
│ --output      -O                   TEXT  Output directory [default: docs/_build]                                             │
│ --git-root                         TEXT  Path to directory in the local repo. Default is CWD.                                │
│ --local-conf                       TEXT  Path to conf.py for sphinx-versions to read config from. [default: docs/conf.py]    │
│ --root-ref    -r                   TEXT  The branch/tag at the root of DESTINATION. Will also be in subdir. [default: main]  │
│ --prebuild        --no-prebuild          Disables the pre-builds; halves the runtime [default: prebuild]                     │
│ --branches    -b                   TEXT  Build docs for specific branches and tags [default: None]                           │
│ --quite           --no-quite             No output from `sphinx` [default: quite]                                            │
│ --help                                   Show this message and exit.                                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯