All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Added: custom styling for the table preview in
audbcards
- Added: support for Python 3.12
- Added: support for Python 3.11
- Changed: require
sphinx<7.0.0
- Removed: support for Python 3.7
- Fixed: font files weren't included in Python package
- Added: support for Python 3.10
- Added: "Research" link in footer
- Changed: use new audEERING logo
- Changed: mark extension safe for parallel read and write
- Changed: "Infrastructure" link in footer now points to http://devops.pp.audeering.com
- Changed: rename "Infrastructure" link in footer to "Infra"
- Changed: rename "Documentation" link in footer to "Docs"
- Removed: dependency to
sphinx_rtd_theme
; the required source files are now included
- Fixed: reduced bottom margin of nested bullet points
- Fixed: floating of class properties in API docs
- Fixed: margin of class properties in API docs
- Fixed: display italic text in docstrings as italic
- Changed: link to infrastructure page in footer
- Added: Python 3.9 support
- Removed: Python 3.6 support
- Changed: link to infrastructure page in footer
- Changed: use always bold, black font for inline code
- Changed: use bold, black font for function/class name in API
- Changed: intend after first line in API parameter lists
- Fixed: parameter list in API was still showing bullet points for some documentations
- Fixed: bottom margin of table cells in API
- Fixed: bottom margin of paragraphs in API
- Changed: use new logo, favicon and colors from audEERING homepage
- Changed: link only to root of repo in Github/Gitlab links in the page header
- Changed:
pygments
style tofriendly
- Changed: remove border around code blocks
- Changed: inline code has no longer a background color or border
- Changed: let example section in API docs appear like other sections
- Changed: remove bullet points in API listings
- Changed: use only red or grey for admonitions
- Fixed: bottom margin for table headers
- Fixed: reduce bottom margin for tables in docstring
- Fixed: pin
docutils<0.17
to avoid formatting errors
- Fixed: Javascript error in search for
sphinx>=3.4.0
- Fixed: pin
sphinx-rtd-theme
to version 0.4.3 to avoid CSS and font incompatibilities
- Added: link to internal models page in footer
- Fixed: code example on the documentation page for wide pages
- Changed: switch PNG version of audEERING logo for SVG logo
- Fixed: included missing JS file for search
- Added: long-description to
setup.cfg
, which will be shown on pypi.org - Added: links to usage and installation documentation to README
- Fixed: multi-line statements in Github release changelog
- Fixed: release instructions for Github
- Changed: show only bullet points in Github release
- Fixed: support multi-line changelog entries in Github release
- Fixed: replaces missing 1.0.4 version
- Changed: show only bullet points in Github release
- Fixed: support multi-line changelog entries in Github release
- Added: create automatic releases on Github
- Changed: switch to Github pages for documentation
- Added: support for "Edit on Github" links
- Added: badges to :file:`README.rst`
- Added: list theme features in :file:`README.rst`
- Added: test for broken links in docs
- Fixed: removed long description from package
- Added: first public release on Github
- Added: link to documentation to :file:`setup.cfg`
- Added: links to main documentation pages in footer,
can be disabled by the theme option
footer_links
- Added: date the documentation was built to footer
- Added: style jupyter-sphinx plugin by overwriting it's CSS file
using
!important
- Fixed: use 0.4.3 RTD CSS file to fix CSS issues
- Fixed: include missing favicon into wheel package
- Added: :file:`setup.cfg` to define metadata of package
- Changed: switch from MIT to audEERING license as we use official logos
- Changed: use safer name
audeering-wide.css
for CSS for wide pages
- Added:
wide_pages
theme option - Added: support for Python 3.8
- Added: automatic Python package publishing
- Removed: Python 2.7 support
- Fixed: "Edit on Gitlab" link on Gitlab CI
- Added: test for "Edit on Gitlab" URL extraction
- Fixed: "Edit on Gitlab" link for projects
- Fixed: "Edit on Gitlab" link for sub-projects
- Fixed: make table captions equal to figure captions
- Fixed: figure captions for singlehtml pages
- Changed: switch Sphinx URL in footer to internal doc
- Fixed: automatic branch name on Gitlab CI
- Added: "Edit on Gitlab" link
- Changed: remove Sphinx related documentation
- Fixed: Gitlab and Artifactory URLs
- Fixed: add space for download symbol for notebooks
- Fixed: download symbol for Jupyter notebooks
- Added: documentation examples for tables
- Fixed: several CSS flaws for tables
- Changed: deploy documentation as Gitlab pages
- Fixed: footer link to theme
- Added: support for Python 2.7
- Fixed: links to internal Gitlab server in docs
- Added: Gitlab CI tests
- Changed: switch to Keep a Changelog format
- Changed: documentation to internal PyPI server
- Changed: switch to PNG logo
- Changed: update red and black color
- Fixed: heading colors in left menu
- Added: Jupyter notebook line
- Changed: adjust red background color
- Changed: adjust a:hover color
- Added: initial release