- 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)
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 selectmain
,v2.0
and will excludev1.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 selectmain
and will excludev1.0
andv2.0
. Similarly, the argument--branch -main,v*
will selectv1.0
andv2.0
and will excludemain
.Note: selecting a branch takes presidence over excluding one. (#80)
- Fixed branch not found bug when selecting branches using -b in CLI.
- Fixed conda-forge builds by setting
git_python_refresh
environ toquite
. (#62)
- 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)
- 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 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)
- Removed
--list-branches
and-l
arg in cli-app. (#39)
- Added sphinx_compatibility kwarg to help generate documentations for versions using deprecated function. Currently, monkey patching app.add_stylesheet -> app.add_css_file. (#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)
- Hotfix for #17. It solves by resetting the intersphinx mapping var for the next execution. Forces
--no-prebuild
. (#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)
- Fixed a bug where versions menu was working from the top-level however, it used fail when accessing other versions from deep links. (#37)
- Migrating call command from
sphinx-versioned build
to justsphinx-versioned
for simplicity. (#21)
- Added
--list-branches
and-l
arg in cli-app. (#22)
- 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 ofgitpython
. (#15)
- 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 astr
argument of the form "main, master". (#12)
- Fixed click 8+ compatibility and
add_css_file
. (#1) - Fixed version menu loading issue with
sphinx_rtd_theme
. (#11)
- Updated documentation with respect to new functionalities. (#6)
- Updated documentation, added
docs/install.rst
,docs/api.rst
and more. (#16)
- 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
andalabaster
themes. (#13) - Migrating to
towncrier
for changelog management. (#19)