Skip to content
This repository was archived by the owner on May 9, 2024. It is now read-only.

Update sphinx-rtd-theme to 0.3.0#76

Closed
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-sphinx-rtd-theme-0.2.4-to-0.3.0
Closed

Update sphinx-rtd-theme to 0.3.0#76
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-sphinx-rtd-theme-0.2.4-to-0.3.0

Conversation

@pyup-bot
Copy link
Contributor

@pyup-bot pyup-bot commented Apr 5, 2018

This PR updates sphinx-rtd-theme from 0.2.4 to 0.3.0.

Changelog

0.2.5

.. code:: python

 html_theme = "sphinx_rtd_theme"

Via git or download
-------------------

Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
``conf.py`` file:

.. code:: python

 html_theme = "sphinx_rtd_theme"
 html_theme_path = ["_themes", ]

Configuration
=============

You can configure different parts of the theme.

Project-wide configuration
--------------------------

The theme's project-wide options are defined in the ``sphinx_rtd_theme/theme.conf``
file of this repository, and can be defined in your project's ``conf.py`` via
``html_theme_options``. For example:

.. code:: python

 html_theme_options = {
     'typekit_id': hiw1hhg,
     'canonical_url':
     'analytics_id':
     'collapse_navigation': False
     'sticky_navigation': False
     'navigation_depth': 4
     'includehidden': True
     'logo_only':
     'display_version': True
     'prev_next_buttons_location': bottom
 }

The following options are available:

* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash.
* ``includehidden`` Specifies if the global toctree includes toctrees marked with the `:hidden:` option
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly

Page-level configuration
------------------------

Pages support metadata that changes how the theme renders.
You can currently add the following:

* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL
* ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL
* ``:gitlab_url:`` This will force the "Edit on GitLab" to the configured URL

Changelog
=========

master
------

* Include fontawesome-webfont.woff2 in pip package
* Updated wyrm_ and Font Awesome
* Split multiple data types on different lines
* Italicize ``.versionmodified``
* Fix line number spacing to align with the code lines
* Hide Edit links on auto created pages
* Align ``.. centered::`` text to the center
* Increase contrast for footnotes
* Add language to the JS output variable
* Include the lato italics font with the theme
* Fix padding on field lists
* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
Sphinx ``html_theme`` directly.
Links

@coveralls
Copy link

coveralls commented Apr 5, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling 381e8d6 on pyup-update-sphinx-rtd-theme-0.2.4-to-0.3.0 into 6c6ceaf on master.

@pyup-bot
Copy link
Contributor Author

pyup-bot commented May 2, 2018

Closing this in favor of #82

@pyup-bot pyup-bot closed this May 2, 2018
@delgadom delgadom deleted the pyup-update-sphinx-rtd-theme-0.2.4-to-0.3.0 branch May 2, 2018 16:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants