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.1.tar.gz
(343.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx-versioned-docs-1.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fba1039cfdac1206414f5f21de8f01a14a5358ab4c296998a325074019569c2c |
|
MD5 | df146a7cbb375fcffea8342e964b3316 |
|
BLAKE2b-256 | 5878e7527be37488cb1f746c17aaf114f72bceb1ad2718451d76caeed38d2206 |
Close
Hashes for sphinx_versioned_docs-1.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3db2f1726a26bcc8b2035a0fb14e1025c21f54a39d9cd92d6f2e3fa03d2d8ca |
|
MD5 | b9271e807e244067a714941985b5d3cb |
|
BLAKE2b-256 | 7cf54384d3c90a03bc146731c487dda6a31e4d6cde8c63e24cb7175d17b5a4c6 |