Skip to content

Commit

Permalink
feat: use same theme as pystac
Browse files Browse the repository at this point in the history
That's pydata-sphinx-theme for those keeping score at home.
  • Loading branch information
gadomski committed May 3, 2022
1 parent 7db5b1b commit 7802a33
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ dependencies:
- lxml-stubs
- mypy
- nbsphinx
- pydata-sphinx-theme
- pylint
- sphinx
- sphinx-autobuild
- sphinx-click
- sphinxcontrib-fulltoc
- sphinxcontrib-napoleon
- types-certifi
- types-orjson
Expand Down
Binary file added docs/_static/stactools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 24 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.extlinks",
"sphinxcontrib.fulltoc",
"sphinx_click",
"nbsphinx",
]
Expand Down Expand Up @@ -84,21 +83,30 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
html_theme = "pydata_sphinx_theme"
html_logo = "_static/stactools.png"

# 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 = {
"show_powered_by": False,
"github_user": "stac-utils",
"github_repo": "stactools",
"github_banner": True,
"show_related": False,
"note_bg": "#FFF59C",
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/stac-utils/stactools",
"icon": "fab fa-github-square",
"type": "fontawesome",
}
],
"external_links": [
{"name": "STAC spec", "url": "https://stacspec.org/"},
{"name": "PySTAC", "url": "https://pystac.readthedocs.io/en/stable/"},
],
"show_nav_level": 3,
}


# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand All @@ -112,7 +120,14 @@
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
html_sidebars = {
"**": [
"search-field.html",
"globaltoc.html",
"sourcelink.html",
],
}


# -- Options for HTMLHelp output ---------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ mypy
nbsphinx
packaging
pre-commit
pydata-sphinx-theme
pylint
pytest
pytest-cov
sphinx
sphinx-autobuild
sphinx-click
sphinxcontrib-fulltoc
sphinxcontrib-napoleon
types-certifi
types-orjson
Expand Down

0 comments on commit 7802a33

Please sign in to comment.