A Sphinx extension to manage versioned documentation
Project description
sphinx_versioning
A Sphinx extension to manage versioned documentation.
Overview
sphinx-versioning
is a Sphinx extension that manages versioned documentation, allowing users to maintain multiple versions of their documentation with ease. This plugin makes it simple to create, view, and navigate between different versions, providing an enhanced user experience.
Feature
-
Version Creation: Easily create new versions of your documentation with a command-line - interface.
-
Version Deletion: Manage your existing versions, including the ability to delete obsolete ones.
-
Version Navigation: Conveniently navigate between different versions through a drop-down menu.
Installation
pip install sphinx-versioning
Usage
Configuration in Sphinx
- In your Sphinx project's conf.py file, add 'sphinx_versioning' to the extensions list:
extensions = [
...
'sphinx_versioning',
...
]
- Update your
conf.py
file to include thesphinx_versioning.html
template in the html_sidebars configuration:
html_sidebars = {
'**': [
# ... other sidebars ...
'sidebar/sphinx_versioning.html',
]
}
- If you haven't, set html static path as follow:
html_static_path = ['_static']
Command Line Interface
The sphinx-version command-line tool provides functionality to manage versions:
- Create a New Version based based the current source file:
sphinx-version --version VERSION_NAME
- sphinx-version --version VERSION_NAME -d
sphinx-version --version VERSION_NAME -d
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_versioning-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a960fe5ef96f991eb97187881a6d3def78a47b2e486a448a5d28546edc3273c2 |
|
MD5 | 41c70295a4da78296d83ba032c3422ee |
|
BLAKE2b-256 | 69f66d0cf2d91365ac208ee7f05b912740f47a3d0eab2cdfb3023742a8b57f14 |