Skip to content

Commit

Permalink
Changed the Sphinx documentation theme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasstolker committed Jul 26, 2021
1 parent 98ef71d commit 35e6aef
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 12 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ install:
- pip install --upgrade -r requirements.txt
- pip install pytest-cov
- pip install coveralls
- pip install sphinx_book_theme

script:
- pytest --cov=diskmap
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
:target: https://pypi.python.org/pypi/diskmap

.. image:: https://img.shields.io/travis/tomasstolker/diskmap
:target: https://travis-ci.org/tomasstolker/diskmap
:target: https://travis-ci.com/tomasstolker/diskmap

.. image:: https://img.shields.io/readthedocs/diskmap
:target: http://diskmap.readthedocs.io
Expand Down
21 changes: 14 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,25 @@
# 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 = 'sphinx_book_theme'

# 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
# documentation.
#
html_theme_options = {'collapse_navigation': False,
'display_version': False,
'sticky_navigation': True,
'prev_next_buttons_location': 'bottom',
'navigation_depth': 5,
'logo_only': True}
html_theme_options = {
'path_to_docs': 'docs',
'repository_url': 'https://github.com/tomasstolker/diskmap',
'repository_branch': 'main',
'launch_buttons': {
'binderhub_url': 'https://mybinder.org',
'notebook_interface': 'jupyterlab',
},
'use_edit_page_button': True,
'use_issues_button': True,
'use_repository_button': True,
'use_download_button': True,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
Binary file modified docs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
nbsphinx
pandoc
jupyter
sphinx_book_theme
8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
astropy
numpy
scipy
typeguard
astropy ~= 4.1.0
numpy ~= 1.21.0
scipy ~= 1.7.0
typeguard ~= 2.12.0

0 comments on commit 35e6aef

Please sign in to comment.