coveralls
commented
6 years ago Coverage remained the same at 96.327% when pulling 13ca2c1b4d93fb211ad491501cf4906a56d611e1 on pyup-update-sphinx-rtd-theme-0.2.4-to-0.3.0 into 0d32c2b4e18d300a11b748a552f6adbc3dd8f59d on master.
pyup-bot
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
- PyPI: https://pypi.org/project/sphinx-rtd-theme - Changelog: https://pyup.io/changelogs/sphinx-rtd-theme/ - Repo: https://github.com/rtfd/sphinx_rtd_theme/