v1.4

What's Changed

• Update issue templates by @devanshshukla99 in #64
• Added pr template by @devanshshukla99 in #63
• Consistent version selector menu across themes by @devanshshukla99 in #47
• Added more themes to documentation by @devanshshukla99 in #66
• Removed --branches in favour of --branch and -b by @devanshshukla99 in #67
• Select/exclude a branch from processing by @devanshshukla99 in #69
• Added regex support for selecting and excluding branches and tags by @devanshshukla99 in #80
• windows compatiblity by @devanshshukla99 in #76
• 1.4 rc by @devanshshukla99 in #81

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)
• The CLI option --branches is removed in favour of --branch and -b. (#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)

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

• Adds windows compatibility. (#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)

Full Changelog: v1.3.1...v1.4

v1.4-rc

What's Changed

• Update issue templates by @devanshshukla99 in #64
• Added pr template by @devanshshukla99 in #63
• Consistent version selector menu across themes by @devanshshukla99 in #47
• Added more themes to documentation by @devanshshukla99 in #66
• Removed --branches in favour of --branch and -b by @devanshshukla99 in #67
• Select/exclude a branch from processing by @devanshshukla99 in #69
• Added regex support for selecting and excluding branches and tags by @devanshshukla99 in #80
• windows compatiblity by @devanshshukla99 in #76
• 1.4 rc by @devanshshukla99 in #81

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)
• The CLI option --branches is removed in favour of --branch and -b. (#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)

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

• Adds windows compatibility. (#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)

Full Changelog: v1.3.1...v1.4

v1.3.2

v1.3.2

Minor release for bugfix.

Bug Fixes

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

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

• Fixes conda builds by @devanshshukla99 in #62

Full Changelog: v1.3...v1.3.1

v1.3

1.3 (2024-02-28)

What's Changed

• Improved versions flyout by @devanshshukla99 in #43
• Build detached commits by @devanshshukla99 in #45
• gh-action to deploy versioned docs to gh-pages by @devanshshukla99 in #46
• Added few features to the flyout menu for sphinx-rtd-theme and bootstrap-astropy by @devanshshukla99 in #48
• Testing infrastructure by @devanshshukla99 in #50
• Refactor: segregated building workflow VersionedDocs from __main__.py to build.py by @devanshshukla99 in #49
• Cleanup github-actions by @devanshshukla99 in #51
• Update README.rst by @devanshshukla99 in #52
• Fixed a bug where the versions selector menu shows a scoll-bar in sphinx-rtd-theme by @devanshshukla99 in #55
• Improve package documentation by @devanshshukla99 in #53
• fix minor doc issue by @devanshshukla99 in #56
• fixed towncrier doc feature by @devanshshukla99 in #57
• Added a little sample in README.rst by @devanshshukla99 in #58
• Updated display badges by @devanshshukla99 in #59
• Fixed a bug where assets were being copied multiple times by @devanshshukla99 in #60
• v1.3 release by @devanshshukla99 in #61

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

Bug Fixes

• Fixed a bug in flyout's eventlistener where it erroneously used to trigger on the outer flyout element. (#48)
• Fixed a bug where the versions selector menu shows a scoll-bar in sphinx-rtd-theme. (#55)
• Fixed a bug in which the static assets were being copied to the same location multiple times. (#60)

Added/Improved Documentation

• Added documentation strings. (#39)
• Added a sample github-action to showcase the process of building and deploying versioned docs to github-pages/other-locations. (#46)
• Improved package-wide documentation. Added doc-strings and improved tutorial and installation instructions for fresh users. (#53)

Full Changelog: v1.2...v1.3

v1.3-rc

What's Changed

• Improved versions flyout by @devanshshukla99 in #43
• Build detached commits by @devanshshukla99 in #45
• gh-action to deploy versioned docs to gh-pages by @devanshshukla99 in #46
• Added few features to the flyout menu for sphinx-rtd-theme and bootstrap-astropy by @devanshshukla99 in #48
• Testing infrastructure by @devanshshukla99 in #50
• Refactor: segregated building workflow VersionedDocs from __main__.py to build.py by @devanshshukla99 in #49
• Cleanup github-actions by @devanshshukla99 in #51
• Update README.rst by @devanshshukla99 in #52
• Fixed a bug where the versions selector menu shows a scoll-bar in sphinx-rtd-theme by @devanshshukla99 in #55
• Improve package documentation by @devanshshukla99 in #53
• fix minor doc issue by @devanshshukla99 in #56
• fixed towncrier doc feature by @devanshshukla99 in #57
• Added a little sample in README.rst by @devanshshukla99 in #58
• Updated display badges by @devanshshukla99 in #59
• Fixed a bug where assets were being copied multiple times by @devanshshukla99 in #60

Full Changelog: v1.2...v1.3-rc

v1.2

What's Changed

• Patches intersphinx mapping for now by @devanshshukla99 in #25
• Refactor prebuild and additional args by @devanshshukla99 in #26
• Removed _rtd_versions.js in sphinx_rtd_theme by @devanshshukla99 in #27
• Fixes build actions by @devanshshukla99 in #28
• fix rtd by @devanshshukla99 in #29
• Generates a top-level index page by @devanshshukla99 in #34
• logger refactor by @devanshshukla99 in #35
• Adds sphinx_compatibility to support older sphinx versions by @devanshshukla99 in #33
• Fixed accessing versions from deep links by @devanshshukla99 in #37
• Update LICENSE by @devanshshukla99 in #38
• Added readme to docs/changes/ by @devanshshukla99 in #40
• Removed ancient unused code + refactor by @devanshshukla99 in #39
• additional changelog by @devanshshukla99 in #41
• changelog by @devanshshukla99 in #42

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

Full Changelog: v1.1...v1.2

v1.1

What's Changed

• fixed doc failure on rtd by @devanshshukla99 in #20
• Towncrier changelog by @devanshshukla99 in #19
• Changed calling command to sphinx-versioned by @devanshshukla99 in #21
• Added --list-branches and -l cli-arg by @devanshshukla99 in #22
• New logger format by @devanshshukla99 in #23
• Fixed Bad git executable error by @devanshshukla99 in #24

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

Full Changelog: v1.0...v1.1

v1.0

What's Changed

• Added support for sphinx-astropy by @devanshshukla99 in #10
• Fix version menu loading issue with sphinx_rtd_theme by @devanshshukla99 in #11
• pre-building to list only successful builds by @devanshshukla99 in #12
• Individual CI jobs for diff themes by @devanshshukla99 in #13
• separate tests for themes by @devanshshukla99 in #14
• windows not compatible :( by @devanshshukla99 in #15
• Update docs by @devanshshukla99 in #16

1.0 (2023-05-03)

Backwards Incompatible Changes

• Breaking previously forked functionality of sphinx-versions.
  (#5)
• The package will now be called via sphinx-versioned.
  (#6)
• Removed windows from the list of compatible platforms due to an
  issue with pwd, which is probably a dependency of gitpython.
  (#15)

Features

• Added support for sphinx-astropy theme.
  (#10)
• Pre-builing all tags and branches to list only succesful builds in
  the versions menu. It will double the build time; however, it can be
  avoided by disabling the pre-building using --no-prebuild arg or
  by specifically selecting the tag/branch names via --branches
  argument, note that it takes a str argument of the form "main,
  master".
  (#12)

Bug Fixes

• Fixed click 8+ compatibility and add_css_file.
  (#1)
• Fixed version menu loading issue with sphinx_rtd_theme.
  (#11)

Added/Improved Documentation

• Updated documentation with respect to new functionalities.
  (#6)
• Updated documentation, added docs/install.rst, docs/api.rst and
  more.
  (#16)

Trivial/Internal Changes

• Added worflows to maintain and verify codestyle using black.
  (#2)
• Added CI infrastructure to test the package against an empty package
  created using sphinx-quickstart.
  (#4)
• Added tests to verify the package against sphinx_rtd_theme,
  astropy_sphinx_theme and alabaster themes.
  (#13)
• Migrating to towncrier for changelog management.
  (#19)

Full Changelog: v0.1...v1.0

v0.1.0-alpha

What's Changed

• fix click and add_css_file by @devanshshukla99 in #1
• codestyle by @devanshshukla99 in #2
• update metadata by @devanshshukla99 in #3
• added build test by @devanshshukla99 in #4
• Major refactor by @devanshshukla99 in #5
• fix rtd by @devanshshukla99 in #7
• Documentation update by @devanshshukla99 in #6

Full Changelog: https://github.com/devanshshukla99/sphinx-versioned-docs/commits/v.01