Skip to content

Commit

Permalink
DOC: Switch to furo theme from sphinx_rtd_theme (#193)
Browse files Browse the repository at this point in the history
  • Loading branch information
bocklund committed May 13, 2021
1 parent f4ebb2f commit 3838556
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Expand Up @@ -12,6 +12,7 @@ Improvements
* Fix a bug where ``plot_interaction`` and ``plot_endmember`` would raise an error when axes were not passed explicitly (`@bocklund`_ - :issue:`191`)
* Fix a bug where reference keys were assumed to be present in ``dataplot``, ``plot_interaction`` and ``plot_endmember`` (`@bocklund`_ - :issue:`191`)
* Documentation: Rewrite phase diagram datasets section, switch paper references to RST citations, reorganize sections into how-to/reference material appropriately (`@bocklund`_ - :issue:`192`)
* Documentation: Switch from ``sphinx_rtd_theme`` to ``furo`` theme (`@bocklund`_ - :issue:`193`)

0.8.3 (2021-05-08)
==================
Expand Down
5 changes: 3 additions & 2 deletions docs/conf.py
Expand Up @@ -84,7 +84,8 @@
exclude_patterns = ['build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "default"
pygments_dark_style = "monokai"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand All @@ -95,7 +96,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion environment-dev.yml
Expand Up @@ -21,6 +21,6 @@ dependencies:
# PyPI
- twine
# Documentation
- furo
- ipython # for pygments syntax highlighting
- sphinx
- sphinx_rtd_theme
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -38,10 +38,10 @@ def readme(fname):
],
extras_require={
'dev': [
'furo',
'ipython', # for pygments syntax highlighting
'pytest',
'sphinx',
'sphinx_rtd_theme',
'twine',
],
'mpi': [
Expand Down

0 comments on commit 3838556

Please sign in to comment.