Sphinx-versioned-docs

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

Deprecations and Removals
-------------------------

- The theme specific versions selector menu/badge is deprecated in favour of consistent experience
across themes. Now, every theme will have the selector menu either in its sidebar or in its
footer(if the theme supports it). (`47 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/47>`__)
- The CLI option ``--branches`` is removed in favour of ``--branch`` and ``-b``. (`67 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/67>`__)


Features
--------

- Added a feature to either have the vanilla versions selector menu or have it as a floating badge via
using either ``--floating-badge`` or ``--badge`` option available through command-line. (`47 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/47>`__)
- Modified the ``--branch``/ ``-b`` to accomodate branch selection/exclusion. Now, any branch can be selected
by mentioning it in ``--branch``/``--b`` and any can be excluded by adding a ``-`` infront of the branch/tag
name in the cli argument.
Like ``--branch main,-v1.0,v2.0`` will select ``main``, ``v2.0`` and will exclude ``v1.0``. (`69 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/69>`__)
- Adds windows compatibility. (`76 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/76>`__)
- Added regex support for selecting and excluding branches and tags.
Now, any branch can be selected by mentioning it in ``--branch``/ ``--b`` and any can be excluded by adding a ``-``
infront of the branch/tag name in the argument.

Suppose there are 3 branches and tags: ``main, v1.0, v2.0``.
The argument ``--branch main,-v*`` will select ``main`` and will exclude ``v1.0`` and ``v2.0``.
Similarly, the argument ``--branch -main,v*`` will select ``v1.0`` and ``v2.0`` and will exclude ``main``.

Note: selecting a branch takes presidence over excluding one. (`80 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/80>`__)

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

Bug Fixes
---------

- Fixed `branch not found` bug when selecting branches using `-b` in CLI.

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

Bug Fixes
---------

- Fixed conda-forge builds by setting ``git_python_refresh`` environ to ``quite``. (`62 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/62>`__)

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

Features
--------

- Adds the capability to build detached heads if either the head is already detached or that particular commit is
specified via `--branches` arg, provided that `--force` is supplied. Additionally, if the main-branch is not
specified via `--main-branch` then the currently checkout out branch/tag will be considered as the main branch
for generating the top-level `index.html`. (`45 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/45>`__)
- Added a searchbar and project url field for `sphinx-rtd-theme` and `bootstrap-astropy`. The project url can
be set using `sv_project_url` option in `conf.py`. (`48 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/48>`__)


Bug Fixes
---------

- Fixed a bug in flyout's eventlistener where it erroneously used to trigger on the outer flyout element. (`48 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/48>`__)
- Fixed a bug where the versions selector menu shows a scoll-bar in `sphinx-rtd-theme`. (`55 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/55>`__)
- Fixed a bug in which the static assets were being copied to the same location multiple times. (`60 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/60>`__)


Added/Improved Documentation
----------------------------

- Added documentation strings. (`39 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/39>`__)
- Added a sample github-action to showcase the process of building and deploying versioned docs to github-pages/other-locations. (`46 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/46>`__)
- Improved package-wide documentation. Added doc-strings and improved tutorial and installation instructions for fresh users. (`53 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/53>`__)

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

Deprecations and Removals
-------------------------

- Removed ``--list-branches`` and ``-l`` arg in cli-app. (`39 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/39>`__)


Features
--------

- Added `sphinx_compatibility` kwarg to help generate documentations for versions using deprecated function.
Currently, monkey patching `app.add_stylesheet` -> `app.add_css_file`. (`33 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/33>`__)
- Generates a top-level index page which redirect to the index page of the main branch.
By default, the main branch is "main" / can be changed using the `--main-branch` kwarg. (`34 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/34>`__)


Bug Fixes
---------

- Hotfix for 17. It solves by resetting the intersphinx mapping var for the next execution. Forces ``--no-prebuild``. (`25 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/25>`__)
- Fixed version menu flyout script in `sphinx_rtd_theme`. Not entirely sure why but somehow `sphinx_rtd_theme` doesn't require the flyout script anymore. (`27 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/27>`__)
- Fixed a bug where versions menu was working from the top-level however, it used fail when accessing other versions from deep links. (`37 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/37>`__)

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

Backwards Incompatible Changes
------------------------------

- Migrating call command from ``sphinx-versioned build`` to just ``sphinx-versioned`` for simplicity. (`21 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/21>`__)


Features
--------

- Added ``--list-branches`` and ``-l`` arg in cli-app. (`22 <https://github.com/devanshshukla99/sphinx-versioned-docs/pull/22>`__)