Add support for multiple versions to sphinx
Project description
sphinx-multiversion
Fork of https://github.com/Holzhaus/sphinx-multiversion for the ScyllaDB Project.
Sphinx extension for building self-hosted versioned docs.
Original documentation can be found at: https://holzhaus.github.io/sphinx-multiversion/
Fork additions
Prebuild and postbuild commands
The fork introduces the possibility to run custom commands before and after building the docs with the option --pre-build
and --post-build
.
This could be useful to prepare the docs repository before running sphinx-build
, debug the execution, or even generate versioned documentation using other builders.
For example, imagine that you want to build versioned docs written in Sphinx, but the API reference is generated with JavaDoc. This option enables the generation of both versioned docs to host them under the same folder using GitHub Pages.
Here's an example showing the directory where the build command is running:
sphinx-multiversion docs build/html --pre-build pw
You can pass multiple commands by adding extra --pre-build
or --post-build
options. The commands run in order, from left to right:
sphinx-multiversion docs build/html --pre-build pwd --pre-build ls --post-build "cat file.txt"
Rename latest version URL
The smv_latest_version
setting determines which is the latest version.
Setting this option could be useful to show a warning when users are not reading the latest version.
You can override the latest version output directory with smv_rename_latest_version
.
Here's an example:
smv_latest_version = 'x.y.z' # Use the branch/tag name
smv_rename_latest_version = 'latest' # Use the commit hash
Add support for custom tags
See https://github.com/dgarcia360/sphinx-multiversion/pull/4
Fix Git LFS error
See https://github.com/scylladb/scylla-enterprise/issues/3414
Enable paralell builds
See https://github.com/scylladb/sphinx-scylladb-theme/pull/891
Version specific overrides
The following properties can be defined on a per-version basis.
rst_prolog
exclude_patterns
: Introduced in 0.3.2
License
BSD 2-Clause License
Copyright (c) 2020, Jan Holthuis jan.holthuis@ruhr-uni-bochum.de All rights reserved.
Modifications (see "Fork Additions") 2020, David Garcia hi@davidgarcia.dev
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
File details
Details for the file sphinx_multiversion_scylla-0.3.2.tar.gz
.
File metadata
- Download URL: sphinx_multiversion_scylla-0.3.2.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f415311273228f4f766c36256503da8e2ce01f9d13423f3fcee3160d6284852b |
|
MD5 | 25b54f50993fbb0a5f794e0878a39e0e |
|
BLAKE2b-256 | 0e48aaa77dc9fedb1671a1729b731f4b359d594bc6af689e230027a6e299d661 |