Docs-versions-menu

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

* Compatibility with ``packaging >= 22.0`` (`27`_, `32`_)

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

* Pin ``packaging`` dependency to ``< 22.0`` (`27`_, `28`_)

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

* Renamed project to ``docs-versions-menu`` (`13`_)
* Changed: Removed support for a config file (`9`_)
* Dropped support for Python 3.5 and Python 3.6
* Added support for Python 3.10 and 3.11
* Improvements to the workflow and documentation.
* Update of conda-feedstock_

.. _migration:


Migration from ``doctr-versions-menu``
--------------------------------------

The ``doctr-versions-menu`` package was renamed to ``docs-versions-menu`` to reflect that Travis_ and thus Doctr_ is `no longer a viable option to deploy documentation <TravisDemiseHN_>`_. Switching from ``doctr-versions-menu`` to ``docs-versions-menu`` requires the following steps:

* Consider switching from Travis_ to `Github Actions`_
* Update your Sphinx configuration (``conf.py``):
* Rename the ``doctr_versions_menu_conf`` dictionary of settings to ``docs_versions_menu_conf``.
* Change the name of the ``doctr_versions_menu`` extension in the ``extensions`` list to ``docs_versions_menu``.
* If using a custom ``doctr-versions-menu.js_t`` template, rename the file to ``docs-versions-menu.js_t``
* Update your continuous-integration setup:
* Replace the ``doctr-versions-menu`` package with ``docs-versions-menu`` in the project requirements (``setup.py``/``setup.cfg``)
* Replace the installation of the ``doctr-versions-menu`` package with ``docs-versions-menu`` in your CI script or environment files
* Replace calls to the ``doctr-versions-menu`` executable with calls to ``docs-versions-menu``
* If using environment variables for configuration, change the ``DOCTR_VERSIONS_MENU`` prefix to ``DOCS_VERSIONS_MENU``
* For any project using a ``doctr-versions-menu.conf`` file in the ``gh-pages`` root, set up equivalent ``DOCS_VERSIONS_MENU_*`` environment variables

To ease migration, the new ``docs-versions-menu`` will still process ``doctr_versions_menu_conf``, ``DOCTR_VERSIONS_MENU`` environment variables, and a ``doctr-versions-menu.js_t`` template, while emitting a warning. This limited backwards-compatibility may be removed in later versions.

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

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

* Fixed: The ``doctr-versions-menu`` exectuable no longer fails when run outside of a git repository (`15`_, thanks to `Alexander Blech <ablech_>`_)
* Fixed: Custom ``doctr-versions-menu.js_t`` template were being ignored (`18`_)

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

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

* 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, ``<default-branch>`` group for folder specifications, and ``default-branch`` field in ``versions.json`` (`12`_)
* Changed: The default ``--versions`` now uses ``<default-branch>``, 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 <GitMainDefaultBranch_>`_ and `Github <GithubMainDefaultBranch_>`_ 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 <TravisDemiseHN_>`_. Consequently, Doctr_ can no longer be used to deploy documentation at no cost. This release adds rudimentary support for deploying the documenation with `Github Actions`_ instead of Doctr, see `Deployment with Github Actions <https://goerz.github.io/docs_versions_menu/v0.4.0/command.html#deployment-with-github-actions>`_.

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

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

* Added: ``--no-downloads-file`` option, ``downloads_file = False`` in config. (`4`_, thanks to `Tyler Pennebaker <ZryletTC_>`_)
* Fixed: ``versions.py`` on ``gh-pages`` branch was not being committed (`5`_)
* Fixed: Compatibility with any ``pyparsing`` version ``>= 2.0.2`` (`8`_, thanks to `Hugo Slepicka <hhslepicka_>`_)
* Added: The ``doctr-versions-menu`` executable can now be configured through environment variables. This allows to keep configuration on the source branch, in the ``.travis.yml`` file (`6`_, thanks to `Tyler Pennebaker <ZryletTC_>`_)
* The Doctr Versions Menu package can now be installed via `conda <conda-feedstock_>`_ (thanks to `Hugo Slepicka <hhslepicka_>`_)