# 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
## Maintenance
This fork will be maintained until the following issues are solved:
- https://github.com/Holzhaus/sphinx-multiversion/issues/45
- https://github.com/Holzhaus/sphinx-multiversion/issues/65
## 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>
Raw data
{
"_id": null,
"home_page": "https://holzhaus.github.io/sphinx-multiversion/",
"name": "sphinx-multiversion-scylla",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jan Holthuis",
"author_email": "holthuis.jan@googlemail.com",
"download_url": "https://files.pythonhosted.org/packages/56/2b/617a7e6d3ba55a026f513a40b5cdd5bc5c25877e3aa0121f175488bfbe24/sphinx-multiversion-scylla-0.3.1.tar.gz",
"platform": null,
"description": "# sphinx-multiversion\n\nFork of https://github.com/Holzhaus/sphinx-multiversion for the ScyllaDB Project.\n\nSphinx extension for building self-hosted versioned docs.\n\nOriginal documentation can be found at: https://holzhaus.github.io/sphinx-multiversion/\n\n## Fork additions\n\n### Prebuild and postbuild commands\n\nThe fork introduces the possibility to run custom commands before and after building the docs with the option `--pre-build` and `--post-build`.\n\nThis could be useful to prepare the docs repository before running `sphinx-build`, debug the execution, or even generate versioned documentation using other builders.\n\nFor 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.\n\nHere's an example showing the directory where the build command is running:\n\n```\nsphinx-multiversion docs build/html --pre-build pw\n```\n\nYou can pass multiple commands by adding extra `--pre-build` or `--post-build` options. The commands run in order, from left to right:\n\n```\nsphinx-multiversion docs build/html --pre-build pwd --pre-build ls --post-build \"cat file.txt\"\n```\n\n### Rename latest version URL\n\nThe `smv_latest_version` setting determines which is the latest version.\nSetting this option could be useful to show a warning when users are not reading the latest version.\n\nYou can override the latest version output directory with `smv_rename_latest_version`.\n\nHere's an example:\n\n```\nsmv_latest_version = 'x.y.z' # Use the branch/tag name\nsmv_rename_latest_version = 'latest' # Use the commit hash\n```\n\n### Add support for custom tags\n\nSee https://github.com/dgarcia360/sphinx-multiversion/pull/4\n\n### Fix Git LFS error\n\nSee https://github.com/scylladb/scylla-enterprise/issues/3414\n\n### Enable paralell builds\n\nSee https://github.com/scylladb/sphinx-scylladb-theme/pull/891\n\n## Maintenance\n\nThis fork will be maintained until the following issues are solved:\n\n- https://github.com/Holzhaus/sphinx-multiversion/issues/45\n- https://github.com/Holzhaus/sphinx-multiversion/issues/65\n\n## License\n\nBSD 2-Clause License\n\nCopyright (c) 2020, Jan Holthuis <jan.holthuis@ruhr-uni-bochum.de>\nAll rights reserved.\n\nModifications (see \"Fork Additions\") 2020, David Garcia <hi@davidgarcia.dev>\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Add support for multiple versions to sphinx",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://holzhaus.github.io/sphinx-multiversion/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a42e7721361f18fe98c92aba9f29e787c637ac528ac31adf197eaf1ea6d6f468",
"md5": "b83ef7b6c38b3c838db46142f6728fa5",
"sha256": "762cfb79f4ea2540653a5e8d30f8b604362cebaafb87934895dcc5a8bea6e255"
},
"downloads": -1,
"filename": "sphinx_multiversion_scylla-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b83ef7b6c38b3c838db46142f6728fa5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11247,
"upload_time": "2023-09-26T10:11:29",
"upload_time_iso_8601": "2023-09-26T10:11:29.450218Z",
"url": "https://files.pythonhosted.org/packages/a4/2e/7721361f18fe98c92aba9f29e787c637ac528ac31adf197eaf1ea6d6f468/sphinx_multiversion_scylla-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "562b617a7e6d3ba55a026f513a40b5cdd5bc5c25877e3aa0121f175488bfbe24",
"md5": "b92b9c5429fdf6adfb9d094a412e1dce",
"sha256": "6c04f35ce76b60c4b54d72c52d299624ddc93f2930606bf76db33c214ca38380"
},
"downloads": -1,
"filename": "sphinx-multiversion-scylla-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b92b9c5429fdf6adfb9d094a412e1dce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11298,
"upload_time": "2023-09-26T10:11:31",
"upload_time_iso_8601": "2023-09-26T10:11:31.959595Z",
"url": "https://files.pythonhosted.org/packages/56/2b/617a7e6d3ba55a026f513a40b5cdd5bc5c25877e3aa0121f175488bfbe24/sphinx-multiversion-scylla-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 10:11:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-multiversion-scylla"
}
JSON