{"library":"sphinx-multiversion","title":"Sphinx Multiversion","type":"library","description":"sphinx-multiversion is a Sphinx extension that enables the creation of multiple versions of your project's documentation. It supports building documentation from different branches or tags in a Git repository, allowing users to easily switch between versions. The current version is 0.2.4. Releases are infrequent but stable, often coinciding with new Sphinx releases or major feature additions.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install sphinx-multiversion"],"cli":null},"imports":["extensions = ['sphinx_multiversion', 'sphinx.ext.autodoc'] # in conf.py"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://holzhaus.github.io/sphinx-multiversion/","github":null,"docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinx-multiversion/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\nimport os\n\nproject = 'My Multi-version Project'\ncopyright = '2024, Your Name'\nversion = '0.1'\nrelease = '0.1.0'\n\nextensions = [\n    'sphinx_multiversion',\n    'sphinx.ext.autodoc',\n]\n\n# Multiversion configuration (adjust regex as needed)\n# Builds documentation for tags matching vX.Y.Z\nsmv_tag_whitelist = r'^v\\d+\\.\\d+\\.\\d+$'\n# Builds documentation for 'main' and 'develop' branches\nsmv_branch_whitelist = r'^(main|develop)$'\n# Default remote to fetch from\nsmv_remote_whitelist = 'origin'\n\n# To build:\n# Run this command from your documentation root (where conf.py is located):\n# sphinx-multiversion . _build/html\n","lang":"python","description":"To set up `sphinx-multiversion`, first add it to your `extensions` list in `conf.py`. Then, configure `smv_tag_whitelist` and `smv_branch_whitelist` with regular expressions to specify which Git tags and branches should have their documentation built. Finally, run the `sphinx-multiversion` command with your source and output directories.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}