docs_versions_menu

A versions menu for Sphinx-based documentation

MIT License

Downloads
1.7K
Stars
28
Committers
2

Bot releases are hidden (Show)

docs_versions_menu - Release 0.4.1

Published by goerz over 3 years ago

  • Fixed: The doctr-versions-menu exectuable no longer fails when run outside of a git repository (#15, thanks to Alexander Blech)
  • Fixed: Custom doctr-versions-menu.js_t template were being ignored (#18)
docs_versions_menu - Release 0.5.0-rc1

Published by goerz over 3 years ago

  • Renamed project to docs-versions-menu (#13)
  • Changed: Removed support for a config file (#9)
  • Dropped support for Python 3.5
docs_versions_menu - Release 0.4.0

Published by goerz almost 4 years ago

  • Added: The label in the top left corner of the version menu can now be configured in conf.py (setting menu_title).
  • Added: --default-branch option, group for folder specifications, and default-branch field in versions.json (#12)
  • Changed: The default --versions now uses , automatically picking up on either "master" or "main" as the default branch (#12)
  • Changed: The default template for index.html now automatically forwards to the default-branch (based on the --default-branch option, instead of just "master"), or the first available branch if there is no released version (#12)

This release addresses two major compatibility issues:

  1. Both git and Github have recently switched the name of the default branch from "master" to "main". This release adds support for new projects using "main" as their default branch.
  2. As of December 2020, Travis CI has stopped their support for open source. Consequently, Doctr can no longer be used to deploy documentation at no cost. This release adds rudimentary support for deploying the documentation with Github Actions instead of Doctr, see Deployment with Github Actions.
Package Rankings
Top 8.13% on Pypi.org
Top 45.4% on Conda-forge.org
Related Projects