2024.11.01

Coeus Sphinx Theme v2024.11.01 Release Notes

Changes

• [Feature] Add support for optional socials by @xames3 in #15
• Feature Release Mk-II by @xames3 in #13
• refactor: add no-rounded-corners by @xames3 in #17

Full Changelog

2024.10.10...2024.11.01

2024.10.10

Coeus Sphinx Theme v2024.10.10 Release Notes

Added Features

1. Video Directive:
   Added support for local or url-based video integration.

2. Support for Folium Map rendering:
   Added support for rendering folium maps when provided in conjunction with Jupyter-Cell markup.

3. Support for Jupyter Notebook rendering:
   Added support for rendering Jupyter Notebooks using JupyterLite and a custom notebook directive.

4. Support for capturing feedbacks:
   Added support for capturing user feedback using the feedback_link option.

5. Support for i18n:
   Added support for internationalization using sphinx-intl and custom language switcher rendering, related to #1

Changes

1. Migrate all non-critical HTML files to Jinja template, related to #5

2. Fix minor styling issues and components like tables, icons, etc.

2024.09.09

Coeus Sphinx Theme v2024.09.09 Release Notes

Added Features

1. Open Graph Protocol:
   Integrated support using sphinxext.opengraph extension.

2. Collapsible TOC and HTML Post Processing:
   Added capabilities for collapsible table of contents in the sidebar and enhanced HTML post-processing.

Changes

1. people Option Update:
   Now handled via docutils.statemachine to support nested parsing in the headshots module. The processing has shifted to the node level.

2. Gradient Option Update in title-hero:
   The gradient option is now optional and managed via CSS animations.

Deprecations

1. people Option:
   Deprecated in favor of a more intuitive list-table layout in both the headshots and contributors modules.

2. article Option:
   Deprecated from the title-hero directive.

3. html_coeus_include_last_updated_date Option:
   Deprecated in favor of traditional Sphinx options.

2024.08.30

Coeus Sphinx Theme v2024.08.30 Release Notes

Added Features

1. YouTube Video Title Fetching:
   Automatically fetch the YouTube video title using the pytube module.

2. Custom YouTube Video Title:
   Support for adding a custom title to YouTube videos using the title option.

3. Bootstrap-native Image Carousels:
   Integrated support for image carousels using extensions like sphinx_carousel.

4. Enhanced Contributors Directive:
   Added options for location, reading time, and document language in the contributors directive.

5. New Headshots Directive:
   Introduced a headshots directive allowing authors and contributors to add personal information, including photos and affiliations.

6. Social Media Integration:
   Automatically list author-provided socials via the html_coeus_socials option.

7. Custom Stylize Role:
   Added support for a custom Sphinx stylize role.

Changes

1. Extension Renaming:

   • The embed_youtube extension is now youtube_video.
   • The documentation_hero extension is now title_hero.
   • The contributor_hero extension is now contributors.
   • The top_ribbon extension is now announcement.

2. Glossary Table Update:
   The glossary_table extension now considers term as content starting with *, rather than content ending with ::. Other functionality remains unchanged.

3. Refactoring and Code Improvements:

   • Extensions have been refactored to minimize code duplication.
   • Docstrings now better justify the code they represent, improving overall extension management.

4. Template Usage:
   Extensions now use a Jinja2 template instead of Jinja2 string rendering, facilitating future enhancements.

5. Conformance to Mypy Restrictions:
   The ClassVar update now adheres to mypy restrictions.

6. Footer Copyrights:
   Proper display of copyrights in the website's footer.

Deprecations

1. Deprecated YouTube Video Directive Options:
   The controls, modestbranding, color, width, and height options for the youtube_video directive are deprecated pending further exploration.

2. Deprecated Social Media Option:
   The html_coeus_twitter option is deprecated in favor of the html_coeus_socials option.

3. Deprecated Module Collection:
   The use of the modules collection is deprecated in favor of directives import.

4. Deprecated Glossary Table Directive:
   The glossary_table directive is deprecated in favor of Sphinx's glossary directive, improving support for the term cross-reference role.