Skip to content
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
2 changes: 2 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ python:
install:
- method: pip
path: .
extra_requirements:
- docs
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ def _reset_ultraplot(gallery_conf, fname):
"sphinxext.custom_roles", # local extension
"sphinx_automodapi.automodapi", # fork of automodapi
"sphinx_rtd_light_dark", # use custom theme
"sphinx_sitemap",
"sphinx_copybutton", # add copy button to code
"_ext.notoc",
"nbsphinx", # parse rst books
Expand Down Expand Up @@ -373,6 +374,8 @@ def _reset_ultraplot(gallery_conf, fname):
# The name of the Pygments (syntax highlighting) style to use.
# The light-dark theme toggler overloads this, but set default anyway
pygments_style = "none"
html_baseurl = "https://ultraplot.readthedocs.io/stable"
sitemap_url_scheme = "{link}"


# -- Options for HTML output -------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ To build the documentation locally, use the following commands:
cd docs
# Install dependencies to the base conda environment..
conda env update -f environment.yml
pip install -e ".[docs]"
# ...or create a new conda environment
# conda env create -n ultraplot-dev --file docs/environment.yml
# source activate ultraplot-dev
Expand Down
16 changes: 1 addition & 15 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ dependencies:
- python>=3.10,<3.14
- numpy
- matplotlib>=3.9
- basemap >=1.4.1
- cartopy
- xarray
- seaborn
Expand All @@ -13,25 +14,10 @@ dependencies:
- pytest-mpl
- pytest-cov
- pytest-xdist
- jupyter
- pip
- pint
- sphinx
- sphinx-gallery
- nbsphinx
- jupytext
- sphinx-copybutton
- sphinx-autoapi
- sphinx-automodapi
- sphinx-rtd-theme
- typing-extensions
- basemap >=1.4.1
- pre-commit
- sphinx-design
- networkx
- pyarrow
- cftime
- m2r2
- lxml-html-clean
- pip:
- git+https://github.com/ultraplot/UltraTheme.git
19 changes: 19 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,22 @@ ignore = ["I001", "I002", "I003", "I004"]

[tool.basedpyright]
exclude = ["**/*.ipynb"]

[project.optional-dependencies]
docs = [
"jupyter",
"jupytext",
"lxml-html-clean",
"m2r2",
"mpltern",
"nbsphinx",
"sphinx",
"sphinx-autoapi",
"sphinx-automodapi",
"sphinx-copybutton",
"sphinx-design",
"sphinx-gallery",
"sphinx-rtd-light-dark @ git+https://github.com/ultraplot/UltraTheme.git",
"sphinx-sitemap",
"typing-extensions"
]