Sphinx extension to build versionsed docs.
Project description
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. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-versioned-docs-1.3.tar.gz
(343.5 kB
view hashes)
Built Distribution
Close
Hashes for sphinx-versioned-docs-1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af366d9220f002ae891d892fbc1e7bb8f2a80d4b634972d0d44aea7ee6423974 |
|
MD5 | 633f3c119b49349dd3beb810e0699914 |
|
BLAKE2b-256 | 6ae2cdf2992ec962845487663f99fdae37d63dc62b41262fedf2b9e1b4b28c1f |
Close
Hashes for sphinx_versioned_docs-1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99966b287c8471d13302f4eaf15798207d8b298e4a9931d2917d956497eb7998 |
|
MD5 | 6ef83d12a97bc833c3d3d0646ec843c2 |
|
BLAKE2b-256 | f43b9dd988df6e9468380bbc602183c5d266dc8bc3c1cd46e43738d6acbcafe9 |