Open Stack

We are excited to announce the release of:

openstackdocstheme 2.1.0: OpenStack Docs Theme

The source is available from:

    https://opendev.org/openstack/openstackdocstheme

Download the package from:

    https://tarballs.openstack.org/openstackdocstheme/

For more details, please see below.

2.1.0
^^^^^


New Features
************

* A new config option, "openstackdocs_auto_name", has been added.
  This can be used to disable auto-configuration of the project name
  through inspection of package metadata.

* A new config option, "openstackdocs_auto_version", has been added.
  This can be used to disable auto-versioning of documentation for
  things like release notes or API references.


Upgrade Notes
*************

* The "openstackdocs_auto_version" option must be configured to
  disable auto-versioning of documentation. Previously, the extension
  would check for an empty string ("''") and, if present, use this to
  indicate that the document should be unversioned. However, this only
  worked if building documentation using the "build_sphinx" distutils
  extension.

* All configuration options are now prefixed with "openstackdocs_".
  Support for the previous configuration option names are considered
  deprecated and will be removed in a future release.


  Affected options
  ^^^^^^^^^^^^^^^^

  +----------------------------------------------------+----------------------------------------------------+
  | New Name                                           | Deprecated Name                                    |
  +====================================================+====================================================+
  | "openstackdocs_repo_name"                          | "repository_name"                                  |
  +----------------------------------------------------+----------------------------------------------------+
  | "openstackdocs_use_storyboard"                     | "use_storyboard"                                   |
  +----------------------------------------------------+----------------------------------------------------+
  | "openstackdocs_bug_project"                        | "bug_project"                                      |
  +----------------------------------------------------+----------------------------------------------------+
  | "openstackdocs_bug_tag"                            | "bug_tag"                                          |
  +----------------------------------------------------+----------------------------------------------------+
  | "openstackdocs_project"                            | "openstack_project"                                |
  +----------------------------------------------------+----------------------------------------------------+


Bug Fixes
*********

* The "latex_engine" and "latex_elements" options, which were
  previously always overridden by the extension, will now be merged
  with user configuration. If "latex_engine" is configured by the
  user, this will be used in-place of the default. If
  "latex_elements", a dictionary, is configured, the values provided
  by the user will be merged with the defaults with user-provided
  defaults preferred.

Changes in openstackdocstheme 2.0.2..2.1.0
------------------------------------------

79393a9 trivial: Add whitespace
7ad72dc Add package prefixes for all config options
0b1eeda css: Namespace Pygments stylesheet
2b258f0 Merge, rather than overwrite, LaTeX settings
1246a46 Add 'openstackdocs_auto_name' config option
2b2e4e5 Add 'openstackdocs_auto_version' config option, path checking
cab397d Mark sphinx extensions thread safe


Diffstat (except docs and test files)
-------------------------------------

openstackdocstheme/__init__.py                     |   4 +
openstackdocstheme/ext.py                          | 176 +++++++++++++++++----
openstackdocstheme/page_context.py                 |   1 +
.../theme/openstackdocs/static/css/native.css      | 147 +++++++++--------
...tackdocs_auto_name-option-efbd1cf9a171f079.yaml |   6 +
...kdocs_auto_version-option-fd03f20373eede39.yaml |  13 ++
.../merge-latex-options-242f10c932f0e6af.yaml      |   9 ++
.../notes/renamed-opts-bbf5d1390ed6ba71.yaml       |  15 ++
9 files changed, 309 insertions(+), 117 deletions(-)