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 pydata-sphinx-theme requirement from <0.14,>=0.13.1 to >=0.13.1,<0.16 #36

Open
wants to merge 4 commits into
base: uPPPP
Choose a base branch
from
Open
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
14 changes: 8 additions & 6 deletions docs/source/conf.py → docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
import sys

_HERE = os.path.dirname(__file__)
_ROOT_DIR = os.path.abspath(os.path.join(_HERE, "../.."))
_ROOT_DIR = os.path.abspath(os.path.join(_HERE, "../"))
_PACKAGE_DIR = os.path.abspath(os.path.join(_HERE, "up4"))
_SUBPACKAGE_DIR = os.path.abspath(os.path.join(_HERE, "up4/plotting"))
sys.path.insert(0, _ROOT_DIR)
Expand All @@ -50,7 +50,7 @@
# The full version, including alpha/beta/rc tags
# Load the package's __version__.py module as a dictionary.
about = {}
with open("../../up4/__version__.py") as f:
with open("../up4/__version__.py") as f:
exec(f.read(), about)

release = about["__version__"]
Expand Down Expand Up @@ -91,7 +91,7 @@
# source_encoding = 'utf-8-sig'

# The root toctree document
master_doc = "index" # NOTE: will be changed to `root_doc` in sphinx 4
master_doc = "source/index" # NOTE: will be changed to `root_doc` in sphinx 4

autosummary_generate = True

Expand Down Expand Up @@ -177,7 +177,7 @@
# a list of builtin themes.

html_theme = "pydata_sphinx_theme"
html_logo = "_static/logo.jpeg"
html_logo = "source/_static/logo.jpeg"

version_match = version if "dev" in version else "v" + version

Expand Down Expand Up @@ -205,7 +205,9 @@
# "icon": "fas fa-arrow-circle-down",
# },
# ],
"switcher": dict(json_url="./_static/version.json", version_match=version_match),
"switcher": dict(
json_url="./source/_static/version.json", version_match=version_match
),
}

html_context = {
Expand All @@ -227,7 +229,7 @@
# 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".
html_static_path = ["_static"]
html_static_path = ["./source/_static"]

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx>=3.0.0,!=6.1.2
pydata-sphinx-theme>=0.13.1,<0.14
pydata-sphinx-theme>=0.13.1,<0.16
numpydoc>=1.4.0
sphinx-copybutton>=0.5.0
2 changes: 1 addition & 1 deletion docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ to more in-depth processing techniques.

.. toctree::
:maxdepth: 1
:caption: Getting Sarted
:caption: Getting Started

basic_tutorial

Expand Down