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 withpwd
, which is probably a dependency ofgitpython
.
(#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 astr
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
andalabaster
themes.
(#13) - Migrating to
towncrier
for changelog management.
(#19)
Full Changelog: v0.1...v1.0