Sphinx extension that allows building versioned docs for self-hosting.
📖 Full documentation: https://sphinxcontrib-versioning.readthedocs.io
.. image:: https://readthedocs.org/projects/sphinxcontrib-versioning/badge/?version=latest :target: https://sphinxcontrib-versioning.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://img.shields.io/appveyor/ci/Robpol86/sphinxcontrib-versioning/master.svg?style=flat-square&label=AppVeyor%20CI :target: https://ci.appveyor.com/project/Robpol86/sphinxcontrib-versioning :alt: Build Status Windows
.. image:: https://img.shields.io/travis/sphinx-contrib/sphinxcontrib-versioning/master.svg?style=flat-square&label=Travis%20CI :target: https://travis-ci.org/sphinx-contrib/sphinxcontrib-versioning :alt: Build Status
.. image:: https://img.shields.io/codecov/c/github/sphinx-contrib/sphinxcontrib-versioning/master.svg?style=flat-square&label=Codecov :target: https://codecov.io/gh/sphinx-contrib/sphinxcontrib-versioning :alt: Coverage Status
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-versioning.svg?style=flat-square&label=Latest :target: https://pypi.python.org/pypi/sphinxcontrib-versioning :alt: Latest Version
Install:
.. code:: bash
pip install sphinxcontrib-versioning
Usage:
.. code:: bash
sphinx-versioning --help
sphinx-versioning build --help
sphinx-versioning push --help
.. changelog-section-start
This project adheres to Semantic Versioning <http://semver.org/>
_.
Added
html_last_updated_fmt
will be the last git commit (authored) date.Fixed
Added
Fixed
Fixed
Fixed
Fixed
Added
--push-remote
Fixed
Added
--banner-greatest-tag
--banner-recent-tag
--show-banner
--banner-main-ref
vhasdoc()
vpathto()
scv_show_banner
scv_banner_greatest_tag
scv_banner_main_ref_is_branch
scv_banner_main_ref_is_tag
scv_banner_main_version
scv_banner_recent_tag
Changed
scv_is_root_ref
to scv_is_root
.Fixed
Removed
scv_root_ref_is_branch
scv_root_ref_is_tag
Added
--git-root
command line option.--whitelist-branches
and --whitelist-tags
command line options.--local-conf
and --no-local-conf
command line options.Changed
--prioritize
to --priority
.-S
to -s
.--chdir
, --no-colors
, and --verbose
must be specified before build/push and the other after.--sort
no longer takes a comma separated string. Now specify multiple times (like --grm-exclude
).--sort
value "chrono" to "time".REL_SOURCE
before the destination arguments.-C
to -N
for consistency with sphinx-build.Fixed
-v
to make SCVersioning verbose and two or more
to make sphinx-build verbose.--no-colors
also turns off colors from sphinx-build.Added
scv_is_branch
scv_is_root_ref
scv_is_tag
scv_root_ref_is_branch
scv_root_ref_is_tag
scv_is_greatest_tag
scv_is_recent_branch
scv_is_recent_ref
scv_is_recent_tag
Changed
Fixed
Fixed
.. changelog-section-end