Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update sphinx documentation theme #304

Merged
merged 2 commits into from
Jul 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 0 additions & 74 deletions doc/_static/theme_overrides.css

This file was deleted.

15 changes: 7 additions & 8 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
# General information about the project.
project = "atlite"
author = "The Atlite Authors"
copyright = "2016-2012" + ", " + author
copyright = "2016-2023" + ", " + author
documentation_title = "Atlite Documentation"

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -145,24 +145,23 @@

# 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 = {
"display_version": True,
"sticky_navigation": True,
# 'style_nav_header_background': '#009682',
"repository_url": "https://github.com/pypsa/atlite",
"use_repository_button": True,
"show_navbar_depth": 1,
}


# These folders are copied to the documentation's HTML output
html_static_path = ["_static"]
# html_static_path = ["_static"]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = ["theme_overrides.css"]
# html_css_files = ["theme_overrides.css"]


# The name for this set of Sphinx documents. If None, it defaults to
Expand Down
38 changes: 0 additions & 38 deletions doc/environment.yaml

This file was deleted.

8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@
"cdsapi",
],
extras_require={
"docs": ["numpydoc", "sphinx", "sphinx_rtd_theme", "nbsphinx", "nbsphinx-link"],
"docs": [
"numpydoc",
"sphinx",
"sphinx-book-theme",
"nbsphinx",
"nbsphinx-link",
],
"dev": ["pre-commit", "pytest", "pytest-cov", "matplotlib"],
},
classifiers=[
Expand Down