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
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. [default: main] │
│ --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] │
│ --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.2.tar.gz
(136.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx-versioned-docs-1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fa444d70e392ceaf6269b5e38dc0a2f6a0a2f99d245ee4ea9e2b45d0e63f953 |
|
MD5 | c20f80fb092e264d04b83d1440624278 |
|
BLAKE2b-256 | 268e0f34fea3c245e8890f77649c389dd26bca5b53011e57c35474b06b7d35a6 |
Close
Hashes for sphinx_versioned_docs-1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea12ff8347a4a273b714524b8c904c11eea4c2e4998777046ccc198a51348e4f |
|
MD5 | af49939cf09e6a51e5a55f6cde50de49 |
|
BLAKE2b-256 | 0cf35ba2c052f3983564e1ff5e73d491bfdc00bb42d34d630ffd1333f2d09de8 |