sphinx-versioned-docs 1.3.2

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

sphinx-versioned-docs in action!

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]                     │
│ --reset-intersphinx     -rI                          Reset intersphinx mapping; acts as a patch for issue #17                                             │
│ --sphinx-compatibility  -Sc                          Adds compatibility for older sphinx versions by monkey patching certain functions.                   │
│ --prebuild                    --no-prebuild          Disables the pre-builds; halves the runtime [default: prebuild]                                      │
│ --branches              -b                     TEXT  Build docs for specific branches and tags [default: None]                                            │
│ --main-branch           -m                     TEXT  Main branch to which the top-level `index.html` redirects to. Defaults to `main`. [default: None]    │
│ --quite                       --no-quite             No output from `sphinx` [default: quite]                                                             │
│ --verbose               -v                           Passed directly to sphinx. Specify more than once for more logging in sphinx.                        │
│ --log                   -log                   TEXT  Provide logging level. Example --log debug, default=info [default: info]                             │
│ --force                                              Force branch selection. Use this option to build detached head/commits. [Default: False]             │
│ --help                                               Show this message and exit.                                                                          │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯