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
How to use
sphinx-versioned --help
sphinx-versioned build --help
Usage: sphinx-versioned build [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. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
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.0.tar.gz
(131.1 kB
view hashes)
Built Distribution
Close
Hashes for sphinx-versioned-docs-1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5628d25f68121a6324043fb1837d3c10bbd1a3baba42dc6119dcc09a7fbbc8f5 |
|
MD5 | 8267db9134851016f514393025f551b6 |
|
BLAKE2b-256 | 368f3372f7032a86b71214a522771940413098943d93a1e1099ff09714e098c6 |
Close
Hashes for sphinx_versioned_docs-1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8add8cddf563594f921ded44075dd54f71e26a4b9ebef1a190531fdd18423cc |
|
MD5 | 324e0bc88750d888adf3bb4ad9c7c566 |
|
BLAKE2b-256 | 6819c600980e9bb583f3b14b46ad1cf2dbbe02daf5ead2b0ac861381cbea46a6 |