Changelogs » F5-sphinx-theme

F5-sphinx-theme

2.0.1

Includes bug fix for Sphinx 2.0 search issue.

2.0.0


      

2.0.0b6

Made TOC on right with white background.
Made both TOCs more narrow.
Fixed an issue with code numbering (white space).

2.0.0b5

PDF link

2.0.0b4

Just another release to get in sync with init.py

2.0.0b3

Added PDF button rather than text. Updated padding around top and version notices.

2.0.0b2

Changes from 2.0.0b1 plus:
Updates to help with Google mobile issues
Changes to header to more closely match Askf5.com
Removed warning banner

2.0.0b1

- Split table of contents
- Create PDF button
- Banner when non-prod site
- Next/Prev button style updates
- Search result fix (update extensions in conf.py to include sphinxprettysearchresults)
- Lists within lists generate properly
- Updated bootstrap and fontawesome versions
- Fix to keep breadcrumbs when TOC disappears.

1.0.9

Description
This is hot fix for removing extra dashes from html head

1.0.8

This release includes the following changes:

https://jira.pdsea.f5net.com/browse/CLDOCS-67
https://jira.pdsea.f5net.com/browse/CLDOCS-63

1.0.8b2

* Update to how version/release number gets rendered on sidebar

1.0.8b1

* Add metadata tags required for Coveo integration

1.0.7


      

1.0.7b1

Style changes:
font changed to be F5 standard (some limitations on license; using same fonts as DevCentral)
heading sizes changed so they're easier to differentiate between (and padding added around them)
:guilabel: is now plain text bold
``code`` is now grey background that matches code-block
admonitions (note, important, tip, etc) changed to grey with accent color, less padding, 90% instead of full width
table changes: header color, thin border, border between rows, less padding
version sidebar made a bit smaller
Heading menu updated to have F5 look and feel
Copy code button css updates. Copy code functionality is part of container so styles should be good when the extension is added to container (soon).

Bug fixes:
Footer for short pages stays at the bottom of the page (previously it would float up and chop off TOC)
All ordered lists have consistent spacing (previously when you had additional text in an ordered list it expanded, when no text, it contracted)
TOC pane now has a consistent width (previously it changed based on topic)

1.0.6

- TOC sticky
- TOC expand/collapse
- TOC updated colors
- TOC word wrap and indentation alignment
- Header overlaps the TOC and page

1.0.6b1

TOC is now sticky, colors black/white/grey, has expand/collapse, resizes to fit browser. Top menu extended to overlap with TOC.

1.0.5

Release Highlights
This release implements the new React-based version selector. See the README for information and usage instructions.

View the [changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.4...v1.0.5)

Analytics: The Google TM scripts replace the Adobe TM scripts in this release.

To do:

- Enforce the html_date_last_updated format required by AskF5.

1.0.5b1

Release Highlights
This beta release implements the new version selector. See the README for information and usage instructions.

View the [changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.4...v1.0.5b1)

To do:

- Enforce the html_date_last_updated format required by AskF5.

1.0.4

Release Highlights

- bugfix for 70; added a new theme option (base_url) which defaults to '/'; this allows projects to swap in a different base_URL, such as that of the staging site.
- Removed the version selector functionality; requires further development
- uses correct AskF5 format for product metadata
- use the header and footer from clouddocs/clouddocs-staging
- testing and deployment improvements:

- sample content is built, tested, and deployed in the container image used for production deployments
- replace htmlproofer with htmlhint

To do:

- Enforce the html_date_last_updated format required by AskF5.
- Integrate the version selector

View the [changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.2...v1.0.3))

Notes

Bumped version to v1.0.4 to get around duplicate package error from pypi (even though there was no v1.0.3 uploaded).

1.0.3b4

Release Summary

Same as v1.0.3b3, except had to bump the version again to fix the deployment to PyPi.

This beta release contains:
- bugfix for mobile display on small screens
- testing and deployment improvements
- sample content is built, tested, and deployed in the container image used for production deployments
- replace htmlproofer with htmlhint
- bugfix for 70; added a new theme option (`base_url`) which defaults to '/'; this allows projects to swap in a different `base_URL`, such as that of the staging site.
- version selector bar added by nerdoftech
- uses correct AskF5 format for product metadata
- use the header and footer from the staging site (clouddocs.f5networks.net) instead of building them in to the theme (**SOURCE URL TO BE UPDATED once HTTPS is active for clouddocs.f5.com).

To do:
- Enforce the `html_date_last_updated` format required by AskF5.

[View the changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.2...v1.0.3b4)

1.0.3b3

This beta release contains:
- bugfix for mobile display on small screens
- testing and deployment improvements
- sample content is built, tested, and deployed in the container image used for production deployments
- replace htmlproofer with htmlhint
- bugfix for 70; added a new theme option (`base_url`) which defaults to '/'; this allows projects to swap in a different `base_URL`, such as that of the staging site.
- version selector bar added by nerdoftech
- uses correct AskF5 format for product metadata

To do:
- Enforce the `html_date_last_updated` format required by AskF5.

[View the changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.2...v1.0.3b3)

1.0.2

Release Highlights

This release contains a bugfix for the sidebar formatting, which had issues when viewed in some browser/OS combinations.  (see 66).

View the [changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.1...v1.0.2) for details.

1.0.1

Release Highlights

This release contains a bugfix for the search functionality, which was broken in the previous release (v1.0.0) (63).
It also de-dupes some of the metadata that are added to the head when sphinx builds the documentation.

View the [changelog](https://github.com/f5devcentral/f5-sphinx-theme/compare/v1.0.0...v1.0.1) for details.

1.0.0

Summary
This release includes styling enhancements and packaging updates for the f5-sphinx-theme.

Release Highlights
The following changes of note are included in this release:

- better mobile display (including collapsible sidebar)
- styling to support the Sphinx/docutils ``pullquote`` directive
- styling to support using admonitions as sidebars; e.g.:


.. note::
:class: sidebar

- customize your ToC sidebar using an "extralinks.html" file (see [wiki](https://github.com/f5devcentral/f5-sphinx-theme/wiki) for more info)