Skip to content

Conversation

pyup-bot
Copy link
Collaborator

@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

@ghost ghost assigned pyup-bot Apr 5, 2018
@ghost ghost added the in progress label Apr 5, 2018
@coveralls
Copy link

coveralls commented Apr 5, 2018

Coverage Status

Coverage remained the same at 41.5% when pulling b734167 on pyup-update-sphinx_rtd_theme-0.2.4-to-0.3.0 into 3231212 on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 40.909% when pulling 2d2d358 on pyup-update-sphinx_rtd_theme-0.2.4-to-0.3.0 into 5891629 on master.

@codecov
Copy link

codecov bot commented Apr 5, 2018

Codecov Report

Merging #23 into master will decrease coverage by 0.43%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #23      +/-   ##
==========================================
- Coverage   43.88%   43.44%   -0.44%     
==========================================
  Files           7        7              
  Lines         572      580       +8     
  Branches      111      114       +3     
==========================================
+ Hits          251      252       +1     
- Misses        312      319       +7     
  Partials        9        9
Impacted Files Coverage Δ
src/msquaredc/project.py 16.11% <0%> (-0.15%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3231212...b734167. Read the comment docs.

@ghost ghost assigned j340m3 Apr 5, 2018
@j340m3 j340m3 merged commit 6a6e138 into master Apr 6, 2018
@ghost ghost removed the in progress label Apr 6, 2018
@j340m3 j340m3 deleted the pyup-update-sphinx_rtd_theme-0.2.4-to-0.3.0 branch April 6, 2018 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants