Docs-versions-menu

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

Note: this release was under the project name `doctr-versions-menu`_.

* Added: ``--versions`` option for customizing which folders appear in the versions menu and in which order.
* Added: ``--label`` option for customizing the labels appearing the versions menu
* Added: ``--warning`` option for customizing on which folders specific warnings are displayed
* Added: ``--latest`` option for configuring which folder is the "latest stable release"
* Added: Write a script ``versions.py`` to the root of the ``gh-pages`` branch (``--write-versions-py`` option)
* Changed: unreleased and pre-released versions now show different warnings by default
* Changed: ``index.html`` template is now rendered with full ``version_data``
* Changed: development/pre-release versions now longer have the "dev" suffix in the versions menu by default
* Changed: The versions menu now uses the same ordering of versions as Read-the-Docs, by default: the folders are ordered from most current to least current.
* Changed: internal format of ``versions.json``
* Removed: ``--default-branch`` option. This is replaced by the new ``--latest`` option and enhanced template rendering of the ``index.html``
* Removed: ``--suffix-unreleased`` option. This can now be achieved via the ``--label`` option

This is a major release that breaks backwards compatibility.

Specifically, due to the changes in ``versions.json``, when upgrading from older versions, it
may be necessary to replace ``doctr-versions-menu.js`` files in existing
folders in a project's ``gh-pages`` branch.

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

* Initial release of `doctr-versions-menu`_.

.. _doctr-versions-menu: https://pypi.org/project/doctr-versions-menu/
.. _GithubMainDefaultBranch: https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/
.. _GitMainDefaultBranch: https://github.blog/2020-07-27-highlights-from-git-2-28/#introducing-init-defaultbranch
.. _Travis: https://travis-ci.org
.. _TravisDemiseHN: https://news.ycombinator.com/item?id=25338983
.. _Doctr: https://drdoctr.github.io
.. _Github Actions: https://github.com/features/actions
.. _ZryletTC: https://github.com/ZryletTC
.. _hhslepicka: https://github.com/hhslepicka
.. _ablech: https://github.com/ablech/
.. _4: https://github.com/goerz/docs_versions_menu/issues/4
.. _5: https://github.com/goerz/docs_versions_menu/issues/5
.. _6: https://github.com/goerz/docs_versions_menu/issues/6
.. _8: https://github.com/goerz/docs_versions_menu/issues/8
.. _9: https://github.com/goerz/docs_versions_menu/issues/9
.. _12: https://github.com/goerz/docs_versions_menu/issues/12
.. _13: https://github.com/goerz/docs_versions_menu/issues/13
.. _15: https://github.com/goerz/docs_versions_menu/issues/15
.. _18: https://github.com/goerz/docs_versions_menu/issues/18
.. _27: https://github.com/goerz/docs_versions_menu/issues/27
.. _28: https://github.com/goerz/docs_versions_menu/issues/28
.. _32: https://github.com/goerz/docs_versions_menu/issues/32
.. _conda-feedstock: https://github.com/conda-forge/docs-versions-menu-feedstock#readme