https://github.com/natefoo/sphinxcontrib-simpleversioning

Simplified version linking for Sphinx documentation
https://github.com/natefoo/sphinxcontrib-simpleversioning

Last synced: 14 days ago
JSON representation

Simplified version linking for Sphinx documentation

• Host: GitHub
• URL: https://github.com/natefoo/sphinxcontrib-simpleversioning
• Owner: natefoo
• License: mit
• Created: 2018-01-17T20:54:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-14T00:37:32.000Z (almost 6 years ago)
• Last Synced: 2024-12-18T07:56:21.243Z (20 days ago)
• Language: Python
• Size: 11.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==============================

sphinxcontrib-simpleversioning

==============================

Sphinx extension that allows adding version selection to docs.

* Python 2.7, 3.3, 3.4, and 3.5 supported

This is based on, but is a vastly simplified version of sphinxcontrib.versioning_ intended for building and publishing

documentation with automation/continuous integration tools.

See the sphinxcontrib.versioning_ documentation if you need more features or would like to understand the differences.

.. _sphinxcontrib.versioning: https://robpol86.github.io/sphinxcontrib-versioning/

📖 Full documentation: https://sphinxcontrib-simpleversioning.readthedocs.io/

Quickstart

==========

Install:

.. code:: console

    pip install sphinxcontrib-versioning

Usage (in Sphinx ``conf.py``):

.. code:: python

    extensions.append('sphinxcontrib.simpleversioning')

    simpleversioning_versions = [

        'master',

        {'id': 'dev', 'name': 'latest'},

    ]

.. changelog-section-start

Changelog

=========

This project adheres to `Semantic Versioning `_.

0.0.2 - 2019-02-13

------------------

* Drop reference to unused banner.css from sphinxcontrib.versioning_.

0.0.1 - 2018-01-17

------------------

* Initial development/testing version.

.. changelog-section-end