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

Remove sphinx pin #254

Merged
merged 7 commits into from
May 24, 2024
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
12 changes: 12 additions & 0 deletions .github/workflows/lighthouse.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Lighthouse
on: [pull_request]

jobs:
lighthouse:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Lighthouse
uses: foo-software/lighthouse-check-action@master
with:
urls: "https://docs.sunpy.org/en/stable/,https://docs.sunpy.org/projects/sunpy-sphinx-theme/latest/"
9 changes: 4 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ci:
autoupdate_schedule: "quarterly"
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.4.3"
rev: "v0.4.5"
hooks:
- id: ruff
args: ["--fix", "--unsafe-fixes"]
Expand Down Expand Up @@ -41,8 +41,7 @@ repos:
- id: mixed-line-ending
args: ["--fix=lf"]
- id: trailing-whitespace
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
- repo: https://github.com/crate-ci/typos
rev: v1.21.0
hooks:
- id: codespell
args: ["--write-changes"]
- id: typos
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

This repository contains the sphinx theme used by The Sunpy Project for all online resources.

This theme is a derivative of the excellent [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html), customised to present a uniform navigation over all the projects.
This theme is a derivative of the excellent [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html), customized to present a uniform navigation over all the projects.

For more information see the [documentation](https://sunpy-sphinx-theme.readthedocs.io/).
For more information see the [documentation](https://docs.sunpy.org/projects/sunpy-sphinx-theme/latest/).
24 changes: 24 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
default.extend-ignore-identifiers-re = [
"ANDed", # ANDed
"arange",
"iy1",
"iy2",
"EIS",
"eis",
"EIT",
"eit",
"HAE",
"hsi",
"Hsi",
"nd",
"NDData",
"alog",
"alog10",
"FOVs",
"FOV",
# HEK
"OT",
"ot",
# Coords,
"pn",
]
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import sys
from pathlib import Path

from sphinx_gallery.sorting import ExampleTitleSortKey, ExplicitOrder
from sphinx_gallery.sorting import ExplicitOrder
from sunpy_sphinx_theme import SVG_ICON

# Add the test package to the path so we can import it for automodapi
Expand Down Expand Up @@ -94,7 +94,7 @@
"../examples/section",
]
),
"within_subsection_order": ExampleTitleSortKey,
"within_subsection_order": "ExampleTitleSortKey",
"gallery_dirs": str(Path("generated") / Path("gallery")),
"default_thumb_file": SVG_ICON,
"abort_on_example_error": False,
Expand Down
2 changes: 1 addition & 1 deletion docs/subsections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Aliquam erat volutpat. Pellentesque lorem nisl, faucibus eu augue at, gravida lu
Cdefghijklmnopqrstuvwxyz
========================

Etiam venenatis erat eget orci finibus bibendum. Nulla pretium sollicitudin velit, ut consequat massa facilisis sed. Suspendisse blandit justo a mauris faucibus molestie. Integer id elit auctor ipsum venenatis aliquet. Nulla facilisi. In nulla tortor, vehicula vel blandit in, molestie sit amet tellus. Nulla auctor vitae velit id porttitor. Nullam commodo mattis semper.
Etiam venenatis erat eget orci finibus bibendum. Nulla pretium sollicitudin velit, ut consequat massa facilisis sed. Suspendisse blandit justo a mauris faucibus molestie. Integer id elit auctor ipsum venenatis aliquet. Nulla facilities. In nulla tortor, vehicula vel blandit in, molestie sit amet tellus. Nulla auctor vitae velit id porttitor. Nullam commodo mattis semper.

Defghijklmnopqrstuvwxyz
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/subsections_toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Aliquam erat volutpat. Pellentesque lorem nisl, faucibus eu augue at, gravida lu
Cdefghijklmnopqrstuvwxyz
========================

Etiam venenatis erat eget orci finibus bibendum. Nulla pretium sollicitudin velit, ut consequat massa facilisis sed. Suspendisse blandit justo a mauris faucibus molestie. Integer id elit auctor ipsum venenatis aliquet. Nulla facilisi. In nulla tortor, vehicula vel blandit in, molestie sit amet tellus. Nulla auctor vitae velit id porttitor. Nullam commodo mattis semper.
Etiam venenatis erat eget orci finibus bibendum. Nulla pretium sollicitudin velit, ut consequat massa facilisis sed. Suspendisse blandit justo a mauris faucibus molestie. Integer id elit auctor ipsum venenatis aliquet. Nulla facilities. In nulla tortor, vehicula vel blandit in, molestie sit amet tellus. Nulla auctor vitae velit id porttitor. Nullam commodo mattis semper.

Defghijklmnopqrstuvwxyz
-----------------------
Expand Down
4 changes: 2 additions & 2 deletions examples/example_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
# time to introduce the next code block generates 2 separate figures.

plt.figure()
plt.imshow(z, cmap=plt.cm.get_cmap("hot"))
plt.imshow(z, cmap=plt.get_cmap("hot"))
plt.figure()
plt.imshow(z, cmap=plt.cm.get_cmap("Spectral"), interpolation="none")
plt.imshow(z, cmap=plt.get_cmap("Spectral"), interpolation="none")

##########################################################################
# There's some subtle differences between rendered html rendered comment
Expand Down
4 changes: 2 additions & 2 deletions examples/section/example_template_subsection.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@
# time to introduce the next code block generates 2 separate figures.

plt.figure()
plt.imshow(z, cmap=plt.cm.get_cmap("hot"))
plt.imshow(z, cmap=plt.get_cmap("hot"))
plt.figure()
plt.imshow(z, cmap=plt.cm.get_cmap("Spectral"), interpolation="none")
plt.imshow(z, cmap=plt.get_cmap("Spectral"), interpolation="none")

##########################################################################
# There's some subtle differences between rendered html rendered comment
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ classifiers = [
requires-python = ">=3.9"
dependencies = [
"pydata-sphinx-theme~=0.15.0",
"sphinx<7.3.0"
"sphinx"
]

[project.optional-dependencies]
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pass_env =
set_env =
MPLBACKEND = agg
SUNPY_SAMPLEDIR = {env:SUNPY_SAMPLEDIR:{toxinidir}/.tox/{envname}/sample_data/}
HIDE_PARFIVE_PROGESS = True
HIDE_PARFIVE_PROGRESS = True
deps =
devdeps: git+https://github.com/pydata/pydata-sphinx-theme.git

Expand Down