andy-maier/sphinx-versions

Sphinx extension that allows building versioned docs for self-hosting

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:

sphinx-versions --help
sphinx-versions build --help

Changelog

This project adheres to Semantic Versioning.

1.1.3 - 2019-07-18

Changes

• Fix pdf copy target directory

1.1.2 - 2019-07-18

Changes

• Removes the rest of unicode function calls

1.1.1 - 2019-07-18

Changes

• Removes compatibility with Python 2 (and make it work properly on Pyhton 3 : removing a call to unicode function)

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).

sphinx-versions's Issues

Resolve vacant maintainership

The plan is that I take over maintainership for sphinx-versions. This repo is supposed to become the master repo, and I plan to also get ownership or admin permissions on Pypi.

Things to do:

• Get Pypi ownership transferred (or admin permission added) (by Cyrille Gachot, via LinkedIn)
• Get RTD ownership transferred (or admin permission added) (by Cyrille Gachot, via LinkedIn)
• Announce transition to this repo on the current main repo and on forks from contributors:
  • main repo: https://github.com/Smile-SA/sphinx-versions
  • fork: https://github.com/ANYbotics/sphinx-versions
  • fork: https://github.com/riebecj/sphinx-versions
  • other forks?
• Recreate relevant open issues from https://github.com/Smile-SA/sphinx-versions in this repo
• Merge relevant PRs from other forks into this repo
• Merge branch andy-fixes (the current main target for topic branches) into master

How to use releases from this repo before this issue is resolved: Install from Github, see Releases.