mirror of
https://github.com/vale981/sphinx-versions
synced 2025-03-05 09:41:38 -05:00
54 lines
1.4 KiB
ReStructuredText
54 lines
1.4 KiB
ReStructuredText
===============
|
|
sphinx-versions
|
|
===============
|
|
|
|
Sphinx extension that allows building versioned docs for self-hosting.
|
|
|
|
* Python 3.4, and 3.5 supported on Linux and OS X.
|
|
* Python 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).
|
|
|
|
Full documentation: https://sphinx-versions.readthedocs.io
|
|
|
|
This project is, for the most part, a fork of https://github.com/Robpol86/sphinxcontrib-versioning, with some additions and removals.
|
|
|
|
How to use
|
|
==========
|
|
|
|
Most basic usage:
|
|
|
|
.. code:: bash
|
|
|
|
sphinx-versions --help
|
|
sphinx-versions build --help
|
|
|
|
|
|
.. changelog-section-start
|
|
|
|
Changelog
|
|
=========
|
|
|
|
This project adheres to `Semantic Versioning <http://semver.org/>`_.
|
|
|
|
1.1.0 - 2019-07-18
|
|
------------------
|
|
|
|
Changes
|
|
* Add `-P pdf-file-name.pdf` option, thanks to `Anybotics fork <https://github.com/ANYbotics/sphinx-versions>`
|
|
|
|
|
|
1.0.1 - 2019-04-23
|
|
------------------
|
|
|
|
Changes
|
|
* Update sphinx version from 1.8.4 to 1.8.5
|
|
|
|
1.0.0 - 2018-12-08
|
|
------------------
|
|
|
|
Changes
|
|
* From *sphinxcontrib-versionning* *v2.2.1*, added compatibility with *Sphinx 1.8.2*.
|
|
* From *sphinxcontrib-versionning* *v2.2.1*, removed `push` commands, considered not core for our own usage.
|
|
* Migrates to ``pipenv`` as the recommanded installation process.
|
|
* Use `-s` option instead of `--no-patch` in `git show` (this is for git 1.8.3.1 compatibility).
|
|
|
|
.. changelog-section-end
|