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
tobuild.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-levelindex.html
. (#45) - Added a searchbar and project url field for
sphinx-rtd-theme
andbootstrap-astropy
. The project url can be set usingsv_project_url
option inconf.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