astropy-sphinx-theme 3.0__tar.gz → 3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. astropy_sphinx_theme-3.2/.circleci/config.yml +87 -0
  2. astropy_sphinx_theme-3.2/.github/circle-artifacts.yml +3 -0
  3. astropy_sphinx_theme-3.2/.github/release.yml +20 -0
  4. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.github/workflows/ci_workflow.yml +2 -2
  5. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.github/workflows/publish.yml +2 -2
  6. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.github/workflows/update-changelog.yaml +2 -2
  7. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.gitignore +3 -0
  8. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.pre-commit-config.yaml +4 -4
  9. astropy_sphinx_theme-3.2/.stylelintrc.json +7 -0
  10. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/CHANGES.md +2 -0
  11. {astropy_sphinx_theme-3.0/astropy_sphinx_theme.egg-info → astropy_sphinx_theme-3.2}/PKG-INFO +5 -1
  12. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/README.rst +4 -0
  13. astropy_sphinx_theme-3.2/astropy_sphinx_theme/astropy-unified/static/css/astropy.css +150 -0
  14. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/astropy-unified/theme.toml +7 -1
  15. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap_astropy.py +5 -0
  16. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2/astropy_sphinx_theme.egg-info}/PKG-INFO +5 -1
  17. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme.egg-info/SOURCES.txt +5 -1
  18. astropy_sphinx_theme-3.2/astropy_sphinx_theme.egg-info/scm_file_list.json +48 -0
  19. astropy_sphinx_theme-3.2/astropy_sphinx_theme.egg-info/scm_version.json +8 -0
  20. astropy_sphinx_theme-3.2/tox.ini +61 -0
  21. astropy_sphinx_theme-3.0/.circleci/config.yml +0 -43
  22. astropy_sphinx_theme-3.0/.github/release.yml +0 -20
  23. astropy_sphinx_theme-3.0/.github/workflows/circleci-artifacts-redirector.yml +0 -21
  24. astropy_sphinx_theme-3.0/astropy_sphinx_theme/astropy-unified/static/css/astropy.css +0 -11
  25. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/.github/dependabot.yml +0 -0
  26. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/LICENSE.rst +0 -0
  27. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/MANIFEST.in +0 -0
  28. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/__init__.py +0 -0
  29. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/astropy-unified/static/img/astropy_logo_notext.svg +0 -0
  30. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/astropy-unified/static/img/favicon.ico +0 -0
  31. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/astropy_unified.py +0 -0
  32. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/globaltoc.html +0 -0
  33. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/layout.html +0 -0
  34. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/localtoc.html +0 -0
  35. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/searchbox.html +0 -0
  36. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/astropy_linkout.svg +0 -0
  37. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/astropy_linkout_20.png +0 -0
  38. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo.ico +0 -0
  39. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo.svg +0 -0
  40. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo_32.png +0 -0
  41. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/bootstrap-astropy.css +0 -0
  42. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/copybutton.js +0 -0
  43. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/static/sidebar.js +0 -0
  44. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/bootstrap-astropy/theme.conf +0 -0
  45. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/tests/__init__.py +0 -0
  46. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme/tests/test_basic.py +0 -0
  47. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme.egg-info/dependency_links.txt +0 -0
  48. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme.egg-info/entry_points.txt +0 -0
  49. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme.egg-info/requires.txt +0 -0
  50. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/astropy_sphinx_theme.egg-info/top_level.txt +0 -0
  51. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/docs/Makefile +0 -0
  52. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/docs/colors.rst +0 -0
  53. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/docs/conf.py +0 -0
  54. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/docs/index.rst +0 -0
  55. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/docs/make.bat +0 -0
  56. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/licenses/LICENSE_COPYBUTTON.rst +0 -0
  57. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/pyproject.toml +0 -0
  58. {astropy_sphinx_theme-3.0 → astropy_sphinx_theme-3.2}/setup.cfg +0 -0
@@ -0,0 +1,87 @@
1
+ version: 2.1
2
+ apt-run: &apt-install
3
+ name: Install apt packages
4
+ command: |
5
+ sudo apt update
6
+ sudo apt install -y graphviz build-essential libopenjp2-7 python3-dev pandoc libcairo2-dev
7
+ tox: &tox
8
+ name: Setup tox
9
+ command: |
10
+ python -m pip install --upgrade tox
11
+ jobs:
12
+ website:
13
+ resource_class: large
14
+ docker:
15
+ - image: cimg/python:3.13
16
+ steps:
17
+ - checkout
18
+ - run: *apt-install
19
+ - run: *tox
20
+ - run: python -m tox -e website -- -j 8
21
+ - store_artifacts:
22
+ path: build_preview/_build/html
23
+ theme:
24
+ docker:
25
+ - image: cimg/python:3.13
26
+ steps:
27
+ - checkout
28
+ - run: *apt-install
29
+ - run: *tox
30
+ - run: python -m tox -e build_docs
31
+ - store_artifacts:
32
+ path: build_preview/_build/html
33
+ theme-bootstrap:
34
+ docker:
35
+ - image: cimg/python:3.13
36
+ steps:
37
+ - checkout
38
+ - run: *apt-install
39
+ - run: *tox
40
+ - run: python -m tox -e build_docs-bootstrap
41
+ - store_artifacts:
42
+ path: build_preview/_build/html
43
+ theme-devdeps:
44
+ docker:
45
+ - image: cimg/python:3.13
46
+ steps:
47
+ - checkout
48
+ - run: *apt-install
49
+ - run: *tox
50
+ - run: python -m tox -e build_docs-devdeps
51
+ - store_artifacts:
52
+ path: build_preview/_build/html
53
+ astropy:
54
+ resource_class: large
55
+ docker:
56
+ - image: cimg/python:3.13
57
+ steps:
58
+ - checkout
59
+ - run: *apt-install
60
+ - run: *tox
61
+ # the large resource_class has 4 CPUs but auto detection does not work
62
+ - run: python -m tox -e astropy_docs -- -j 8
63
+ # Remove some parts of the build to speed up upload
64
+ - run: rm -r build_preview/_build/html/.doctrees
65
+ - run: rm -r build_preview/_build/html/_downloads
66
+ - run: rm -r build_preview/_build/html/_sources
67
+ - store_artifacts:
68
+ path: build_preview/_build/html
69
+ css_linting:
70
+ resource_class: small
71
+ docker:
72
+ - image: cimg/node:current
73
+ steps:
74
+ - checkout
75
+ - run: sudo npm install -g stylelint
76
+ - run: sudo npm install stylelint-config-recommended
77
+ - run: sudo stylelint "astropy_sphinx_theme/astropy-unified/**/*.{css,scss,sass}"
78
+ workflows:
79
+ version: 2
80
+ tests:
81
+ jobs:
82
+ - website
83
+ - theme
84
+ - theme-bootstrap
85
+ - theme-devdeps
86
+ - astropy
87
+ - css_linting
@@ -0,0 +1,3 @@
1
+ artifact-path: 0/build_preview/_build/html/index.html
2
+ circleci-jobs: website,theme,theme-bootstrap,theme-devdeps,astropy
3
+ job-title: "--> Rendering Preview <--"
@@ -0,0 +1,20 @@
1
+ changelog:
2
+ exclude:
3
+ authors:
4
+ - pre-commit-ci
5
+ - dependabot
6
+ - pre-commit-ci[bot]
7
+ - dependabot[bot]
8
+ categories:
9
+ - title: Bug Fixes
10
+ labels:
11
+ - bug
12
+ - title: New Features
13
+ labels:
14
+ - enhancement
15
+ - title: Documentation
16
+ labels:
17
+ - Documentation
18
+ - title: Other Changes
19
+ labels:
20
+ - "*"
@@ -21,13 +21,13 @@ jobs:
21
21
  tests:
22
22
  runs-on: ubuntu-latest
23
23
  steps:
24
- - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
24
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
25
25
  with:
26
26
  fetch-depth: 0
27
27
  persist-credentials: false
28
28
 
29
29
  - name: Set up Python
30
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
30
+ uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
31
31
  with:
32
32
  python-version: 3.14
33
33
 
@@ -13,7 +13,7 @@ permissions: {}
13
13
 
14
14
  jobs:
15
15
  build:
16
- uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@e97344095b099e1d729fe97429078c9975921d8a # v2
16
+ uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a # v3.0.3
17
17
  with:
18
18
  save_artifacts: true
19
19
  upload_to_pypi: false
@@ -37,4 +37,4 @@ jobs:
37
37
  path: dist
38
38
 
39
39
  - name: Publish to PyPI
40
- uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
40
+ uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
@@ -17,7 +17,7 @@ jobs:
17
17
 
18
18
  steps:
19
19
  - name: Checkout code
20
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
20
+ uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
21
21
  with:
22
22
  ref: main
23
23
  persist-credentials: false
@@ -30,7 +30,7 @@ jobs:
30
30
  path-to-changelog: CHANGES.md
31
31
 
32
32
  - name: Commit updated CHANGELOG
33
- uses: stefanzweifel/git-auto-commit-action@04702edda442b2e678b25b537cec683a1493fcb9 # v7.1.0
33
+ uses: stefanzweifel/git-auto-commit-action@4a55954c782fc1ea30b9056cd3e7a2b40ca8887d # v7.2.0
34
34
  with:
35
35
  branch: main
36
36
  commit_message: Update CHANGELOG
@@ -5,3 +5,6 @@ build
5
5
  *~
6
6
  astropy_sphinx_theme/version.py
7
7
  docs/_build/
8
+ build_preview
9
+ .tox
10
+ .tmp
@@ -49,18 +49,18 @@ repos:
49
49
  # Forbid files which have a UTF-8 Unicode replacement character.
50
50
 
51
51
  - repo: https://github.com/rbubley/mirrors-prettier
52
- rev: v3.8.1
52
+ rev: v3.9.6
53
53
  hooks:
54
54
  - id: prettier
55
55
  types_or: [css, scss, javascript, rst, json, yaml, toml, markdown]
56
56
 
57
57
  - repo: https://github.com/woodruffw/zizmor-pre-commit
58
- rev: v1.23.1
58
+ rev: v1.29.0
59
59
  hooks:
60
60
  - id: zizmor
61
61
 
62
62
  - repo: https://github.com/astral-sh/ruff-pre-commit
63
- rev: v0.15.9
63
+ rev: v0.16.1
64
64
  hooks:
65
65
  - id: ruff-check
66
66
  args: ["--fix", "--show-fixes"]
@@ -72,7 +72,7 @@ repos:
72
72
  - id: typos
73
73
 
74
74
  - repo: https://github.com/scientific-python/cookie
75
- rev: 2026.04.04
75
+ rev: 2026.06.18
76
76
  hooks:
77
77
  - id: sp-repo-review
78
78
 
@@ -0,0 +1,7 @@
1
+ {
2
+ "extends": "stylelint-config-recommended",
3
+ "rules": {
4
+ "no-descending-specificity": null,
5
+ "selector-pseudo-element-no-unknown": null
6
+ }
7
+ }
@@ -1,5 +1,7 @@
1
1
  # Changelog
2
2
 
3
+ For later releases, please see https://github.com/astropy/astropy-sphinx-theme/releases
4
+
3
5
  ## 2.0 (2025-03-18)
4
6
 
5
7
  - Infrastructure updates. Minimum Python version is now 3.7. [#27]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: astropy-sphinx-theme
3
- Version: 3.0
3
+ Version: 3.2
4
4
  Summary: The sphinx theme for Astropy and affiliated packages.
5
5
  Author-email: The Astropy Developers <astropy.team@gmail.com>
6
6
  License-Expression: BSD-3-Clause
@@ -23,6 +23,10 @@ Dynamic: license-file
23
23
  Astropy Sphinx Theme(s)
24
24
  -----------------------
25
25
 
26
+ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.20229586.svg
27
+ :target: https://doi.org/10.5281/zenodo.20229586
28
+ :alt: Zenodo DOI
29
+
26
30
  This is the repository for the default Astropy project documentation
27
31
  theme(s). To use this theme, simply install this package then add the
28
32
  following line to your documentation's ``conf.py`` file:
@@ -1,6 +1,10 @@
1
1
  Astropy Sphinx Theme(s)
2
2
  -----------------------
3
3
 
4
+ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.20229586.svg
5
+ :target: https://doi.org/10.5281/zenodo.20229586
6
+ :alt: Zenodo DOI
7
+
4
8
  This is the repository for the default Astropy project documentation
5
9
  theme(s). To use this theme, simply install this package then add the
6
10
  following line to your documentation's ``conf.py`` file:
@@ -0,0 +1,150 @@
1
+ /* =========================================================================
2
+ CSS Variables
3
+ ========================================================================= */
4
+
5
+ :root {
6
+ --sst-accent-color-bright: #ff9a6c;
7
+ --sst-accent-color-muted: #ff9a6c;
8
+ }
9
+
10
+ html[data-theme="light"] {
11
+ --pst-color-surface: #f3f4f5;
12
+ --pst-color-border: #d1d5da;
13
+ --pst-color-warning-bg: #f5e4d4;
14
+
15
+ /* Steel blue link/card colors */
16
+ --pst-color-link: #2e6da4;
17
+ --pst-color-link-hover: #1f5080;
18
+ --pst-color-primary: #2e6da4;
19
+ --pst-color-primary-highlight: #1f5080;
20
+ --sd-color-primary-highlight: #1f5080;
21
+
22
+ /* Orange secondary accent */
23
+ --pst-color-secondary: #d07530;
24
+ --pst-color-secondary-highlight: #b85f1f;
25
+ --pst-color-secondary-text: #ffffff;
26
+ --pst-color-secondary-highlight-text: #ffffff;
27
+
28
+ --pst-color-inline-code: #912583;
29
+ --pst-color-inline-code-links: #2e6da4;
30
+ --pst-color-link-higher-contrast: #2e6da4;
31
+
32
+ --pst-color-target: #f3cf95;
33
+
34
+ --sst-footer-background-color: #f6f6f6;
35
+ }
36
+
37
+ html[data-theme="dark"] {
38
+ /* Steel blue link/card colors */
39
+ --pst-color-link: #5b9fd6;
40
+ --pst-color-link-hover: #4a85bc;
41
+ --pst-color-primary: #5b9fd6;
42
+ --pst-color-primary-highlight: #4a85bc;
43
+ --sd-color-primary-highlight: #4a85bc;
44
+
45
+ /* Orange secondary accent */
46
+ --pst-color-secondary: #e08a42;
47
+ --pst-color-secondary-highlight: #d07530;
48
+ --pst-color-secondary--text: #14181e;
49
+ --pst-color-secondary-highlight-text: #14181e;
50
+
51
+ --pst-color-inline-code: #f3c7ee;
52
+ --pst-color-inline-code-links: #5b9fd6;
53
+ --pst-color-link-higher-contrast: #5b9fd6;
54
+
55
+ --pst-color-target: #5a3c19;
56
+
57
+ --sst-footer-background-color: #282828;
58
+ }
59
+
60
+ /* =========================================================================
61
+ Header / Navigation
62
+ ========================================================================= */
63
+
64
+ .bd-header a.navbar-brand {
65
+ color: #ff8457 !important;
66
+ }
67
+
68
+ .bd-header ul.navbar-nav > li.nav-item > .nav-link:hover {
69
+ color: var(--sst-accent-color-bright) !important;
70
+ }
71
+
72
+ .bd-header ul.navbar-nav > li.nav-item > .nav-link:hover:before {
73
+ border-bottom-color: var(--sst-accent-color-bright) !important;
74
+ }
75
+
76
+ /* Theme toggle and GitHub icon hover color */
77
+ html .pst-navbar-icon:hover {
78
+ color: #ff9a6c !important;
79
+ }
80
+
81
+ /* Selected theme in the light/dark mode dropdown */
82
+ html[data-theme="light"] .theme-switch-button + .dropdown-menu {
83
+ --bs-dropdown-link-active-color: #5b9fd6;
84
+ }
85
+
86
+ /* Vertical sidebar/content separator */
87
+ html[data-theme="light"] .bd-sidebar-primary {
88
+ border-right-width: thin;
89
+ border-right-color: #c4c4c4;
90
+ }
91
+
92
+ html[data-theme="dark"] .bd-sidebar-primary {
93
+ border-right-width: thin;
94
+ border-right-color: #666666;
95
+ }
96
+
97
+ /* =========================================================================
98
+ Footer
99
+ ========================================================================= */
100
+
101
+ html[data-theme="light"] .bd-footer {
102
+ border-top: 1px solid #c4c4c4;
103
+ }
104
+
105
+ html[data-theme="dark"] .bd-footer {
106
+ border-top: 1px solid #666666;
107
+ }
108
+
109
+ /* =========================================================================
110
+ Admonitions (dark mode)
111
+ ========================================================================= */
112
+
113
+ /* Muted slate blue for general admonitions (note, important, etc.) */
114
+ html[data-theme="dark"] .admonition {
115
+ border-color: #2e6da4;
116
+ }
117
+ html[data-theme="dark"] .admonition > .admonition-title {
118
+ background-color: #1c4378;
119
+ }
120
+ html[data-theme="dark"] .admonition > .admonition-title:after {
121
+ color: #5b9fd6;
122
+ }
123
+
124
+ /* Orange theming for warning admonitions */
125
+ html[data-theme="dark"] .admonition.warning {
126
+ border-color: #c07030;
127
+ }
128
+ html[data-theme="dark"] .admonition.warning > .admonition-title {
129
+ background-color: #6d4225;
130
+ }
131
+ html[data-theme="dark"] .admonition.warning > .admonition-title:after {
132
+ color: #e08a42;
133
+ }
134
+
135
+ /* =========================================================================
136
+ Typography / Code
137
+ ========================================================================= */
138
+
139
+ code.literal {
140
+ background-color: var(--pst-color-surface);
141
+ border: 1px solid var(--pst-color-border);
142
+ border-radius: 0.25rem;
143
+ padding: 0.1rem 0.25rem;
144
+ }
145
+
146
+ /* Prevent unnecessary vertical scrollbars for MathJax equations */
147
+ mjx-container {
148
+ overflow: visible !important;
149
+ padding-bottom: 0 !important;
150
+ }
@@ -4,6 +4,11 @@ inherit = "sunpy"
4
4
  [options]
5
5
  sst_project_name = "Astropy"
6
6
  sst_site_root = "https://astropy.org"
7
+ # Prune sibling branches in the sidebar toctree so each page only renders
8
+ # its own ancestry. Pydata defaults this to False; astropy's docs have
9
+ # 1400+ pages reachable from a single top-level section, so without this
10
+ # every page's sidebar would contain the entire user guide.
11
+ collapse_navigation = "True"
7
12
  navbar_links = [
8
13
  ["About",
9
14
  [
@@ -32,5 +37,6 @@ navbar_links = [
32
37
  ["Affiliated Packages", "affiliated/index.html", 2],
33
38
  ["Team", "team.html", 2],
34
39
  ]
35
- rtd_extra_search_projects = [["astropy-org-test", "https://astropy-org-test.readthedocs.io"]]
40
+ # Uncomment this when astropy.org migrates to RTD
41
+ # rtd_extra_search_projects = [["astropy-org", "https://astropy.org"]]
36
42
  footer_links = [["Code of Conduct", "code_of_conduct.html", 2]]
@@ -13,3 +13,8 @@ def setup(app):
13
13
  "bootstrap-astropy",
14
14
  Path(__file__).resolve().parent / "bootstrap-astropy",
15
15
  )
16
+
17
+ return {
18
+ "parallel_read_safe": False,
19
+ "parallel_write_safe": False,
20
+ }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: astropy-sphinx-theme
3
- Version: 3.0
3
+ Version: 3.2
4
4
  Summary: The sphinx theme for Astropy and affiliated packages.
5
5
  Author-email: The Astropy Developers <astropy.team@gmail.com>
6
6
  License-Expression: BSD-3-Clause
@@ -23,6 +23,10 @@ Dynamic: license-file
23
23
  Astropy Sphinx Theme(s)
24
24
  -----------------------
25
25
 
26
+ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.20229586.svg
27
+ :target: https://doi.org/10.5281/zenodo.20229586
28
+ :alt: Zenodo DOI
29
+
26
30
  This is the repository for the default Astropy project documentation
27
31
  theme(s). To use this theme, simply install this package then add the
28
32
  following line to your documentation's ``conf.py`` file:
@@ -1,15 +1,17 @@
1
1
  .gitignore
2
2
  .pre-commit-config.yaml
3
+ .stylelintrc.json
3
4
  CHANGES.md
4
5
  LICENSE.rst
5
6
  MANIFEST.in
6
7
  README.rst
7
8
  pyproject.toml
9
+ tox.ini
8
10
  .circleci/config.yml
11
+ .github/circle-artifacts.yml
9
12
  .github/dependabot.yml
10
13
  .github/release.yml
11
14
  .github/workflows/ci_workflow.yml
12
- .github/workflows/circleci-artifacts-redirector.yml
13
15
  .github/workflows/publish.yml
14
16
  .github/workflows/update-changelog.yaml
15
17
  astropy_sphinx_theme/__init__.py
@@ -20,6 +22,8 @@ astropy_sphinx_theme.egg-info/SOURCES.txt
20
22
  astropy_sphinx_theme.egg-info/dependency_links.txt
21
23
  astropy_sphinx_theme.egg-info/entry_points.txt
22
24
  astropy_sphinx_theme.egg-info/requires.txt
25
+ astropy_sphinx_theme.egg-info/scm_file_list.json
26
+ astropy_sphinx_theme.egg-info/scm_version.json
23
27
  astropy_sphinx_theme.egg-info/top_level.txt
24
28
  astropy_sphinx_theme/astropy-unified/theme.toml
25
29
  astropy_sphinx_theme/astropy-unified/static/css/astropy.css
@@ -0,0 +1,48 @@
1
+ {
2
+ "files": [
3
+ ".circleci/config.yml",
4
+ ".github/circle-artifacts.yml",
5
+ ".github/dependabot.yml",
6
+ ".github/release.yml",
7
+ ".github/workflows/ci_workflow.yml",
8
+ ".github/workflows/publish.yml",
9
+ ".github/workflows/update-changelog.yaml",
10
+ ".gitignore",
11
+ ".pre-commit-config.yaml",
12
+ ".stylelintrc.json",
13
+ "CHANGES.md",
14
+ "LICENSE.rst",
15
+ "MANIFEST.in",
16
+ "README.rst",
17
+ "astropy_sphinx_theme/__init__.py",
18
+ "astropy_sphinx_theme/astropy-unified/static/css/astropy.css",
19
+ "astropy_sphinx_theme/astropy-unified/static/img/astropy_logo_notext.svg",
20
+ "astropy_sphinx_theme/astropy-unified/static/img/favicon.ico",
21
+ "astropy_sphinx_theme/astropy-unified/theme.toml",
22
+ "astropy_sphinx_theme/astropy_unified.py",
23
+ "astropy_sphinx_theme/bootstrap-astropy/globaltoc.html",
24
+ "astropy_sphinx_theme/bootstrap-astropy/layout.html",
25
+ "astropy_sphinx_theme/bootstrap-astropy/localtoc.html",
26
+ "astropy_sphinx_theme/bootstrap-astropy/searchbox.html",
27
+ "astropy_sphinx_theme/bootstrap-astropy/static/astropy_linkout.svg",
28
+ "astropy_sphinx_theme/bootstrap-astropy/static/astropy_linkout_20.png",
29
+ "astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo.ico",
30
+ "astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo.svg",
31
+ "astropy_sphinx_theme/bootstrap-astropy/static/astropy_logo_32.png",
32
+ "astropy_sphinx_theme/bootstrap-astropy/static/bootstrap-astropy.css",
33
+ "astropy_sphinx_theme/bootstrap-astropy/static/copybutton.js",
34
+ "astropy_sphinx_theme/bootstrap-astropy/static/sidebar.js",
35
+ "astropy_sphinx_theme/bootstrap-astropy/theme.conf",
36
+ "astropy_sphinx_theme/bootstrap_astropy.py",
37
+ "astropy_sphinx_theme/tests/__init__.py",
38
+ "astropy_sphinx_theme/tests/test_basic.py",
39
+ "docs/Makefile",
40
+ "docs/colors.rst",
41
+ "docs/conf.py",
42
+ "docs/index.rst",
43
+ "docs/make.bat",
44
+ "licenses/LICENSE_COPYBUTTON.rst",
45
+ "pyproject.toml",
46
+ "tox.ini"
47
+ ]
48
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "tag": "3.2",
3
+ "distance": 0,
4
+ "node": "g905ff4ca800316447f46e884335916e612a94fb2",
5
+ "dirty": false,
6
+ "branch": "HEAD",
7
+ "node_date": "2026-09-09"
8
+ }
@@ -0,0 +1,61 @@
1
+ [tox]
2
+ min_version = 4.0
3
+ envlist =
4
+ build_docs{,-devdeps,-bootstrap}
5
+ astropy_docs{,-devdeps}
6
+ website{,-devdeps}
7
+
8
+ [testenv]
9
+ allowlist_externals=
10
+ /bin/sh
11
+ /usr/bin/git
12
+ /usr/bin/make
13
+ pass_env =
14
+ # A variable to tell tests we are on a CI system
15
+ CI
16
+ # Custom compiler locations (such as ccache)
17
+ CC
18
+ # Location of locales (needed by sphinx on some systems)
19
+ LOCALE_ARCHIVE
20
+ # If the user has set a LC override we should follow it
21
+ LC_ALL
22
+ set_env =
23
+ MPLBACKEND = agg
24
+ bootstrap: THEME_NAME = bootstrap-astropy
25
+ !bootstrap: THEME_NAME = astropy-unified
26
+ bootstrap: PARALLEL = 1
27
+ !bootstrap: PARALLEL = auto
28
+ deps =
29
+ devdeps: git+https://github.com/pydata/pydata-sphinx-theme.git
30
+ devdeps: git+https://github.com/astropy/astropy-sphinx-theme.git
31
+
32
+ [testenv:build_docs{,-devdeps,-bootstrap}]
33
+ changedir = docs
34
+ description = Invoke sphinx-build to build the HTML docs
35
+ extras =
36
+ docs
37
+ commands =
38
+ pip freeze --all --no-input
39
+ /bin/sh -c "rm -rf {toxinidir}/build_preview"
40
+ sphinx-build --color -W --keep-going -b html -d _build/.doctrees -D html_theme={env:THEME_NAME} . {toxinidir}/build_preview/_build/html -j {env:PARALLEL} {posargs}
41
+ python -c 'import pathlib; print("Theme Docs available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "build_preview" / "_build" / "html" / "index.html"))'
42
+
43
+ [testenv:astropy_docs{,-devdeps}]
44
+ changedir = .tmp/{envname}
45
+ commands =
46
+ /bin/sh -c "rm -rf {toxinidir}/build_preview"
47
+ /bin/sh -c "git -C astropy pull || git clone https://github.com/Cadair/astropy -b unified-theme"
48
+ python -m pip install -v -e "astropy/.[all,docs]"
49
+ pip freeze --all --no-input
50
+ sphinx-build --color -b html astropy/docs {toxinidir}/build_preview/_build/html {posargs}
51
+ python -c 'import pathlib; print("Astropy Docs available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "build_preview" / "_build" / "html" / "index.html"))'
52
+
53
+ [testenv:website{,-devdeps}]
54
+ changedir = .tmp/{envname}
55
+ commands =
56
+ /bin/sh -c "rm -rf {toxinidir}/build_preview"
57
+ /bin/sh -c "git -C astropy.org pull || git clone --recurse-submodules https://github.com/astropy/astropy.github.com astropy.org"
58
+ python -m pip install -r "astropy.org/requirements.txt"
59
+ pip freeze --all --no-input
60
+ sphinx-build --color -b dirhtml astropy.org/ {toxinidir}/build_preview/_build/html {posargs}
61
+ python -c 'import pathlib; print("Website preview available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "build_preview" / "_build" / "html" / "index.html"))'
@@ -1,43 +0,0 @@
1
- # Python CircleCI 2.0 configuration file
2
- #
3
- # Check https://circleci.com/docs/2.0/language-python/ for more details
4
- #
5
- version: 2.1
6
-
7
- jobs:
8
- build-preview:
9
- parameters:
10
- themename:
11
- type: string
12
-
13
- docker:
14
- - image: cimg/python:3.14
15
-
16
- steps:
17
- - checkout
18
- - run:
19
- name: Install sphinx deps
20
- command: |
21
- python -m pip install ".[docs]"
22
-
23
- - run:
24
- name: Build sphinx
25
- command: |
26
- sphinx-build --color -W --keep-going -b html docs/ docs/_build/html -D html_theme=<< parameters.themename >>
27
-
28
- - store_artifacts:
29
- path: /home/circleci/project/docs/_build/html
30
- destination: html
31
-
32
- workflows:
33
- version: 2
34
-
35
- theme-previews:
36
- jobs:
37
- - build-preview:
38
- name: << matrix.themename >>
39
- matrix:
40
- parameters:
41
- themename:
42
- - "bootstrap-astropy"
43
- - "astropy-unified"
@@ -1,20 +0,0 @@
1
- changelog:
2
- exclude:
3
- authors:
4
- - pre-commit-ci
5
- - dependabot
6
- - pre-commit-ci[bot]
7
- - dependabot[bot]
8
- categories:
9
- - title: Bug Fixes
10
- labels:
11
- - bug
12
- - title: New Features
13
- labels:
14
- - enhancement
15
- - title: Documentation
16
- labels:
17
- - Documentation
18
- - title: Other Changes
19
- labels:
20
- - "*"
@@ -1,21 +0,0 @@
1
- name: Run CircleCI artifacts redirector for rendered HTML
2
- on: [status]
3
-
4
- permissions: read-all
5
-
6
- jobs:
7
- circleci_artifacts_redirector_job:
8
- if: "${(github.repository == 'astropy/astropy-sphinx-theme') && startswith(github.event.context, 'ci/circleci'))}"
9
- runs-on: ubuntu-latest
10
- permissions:
11
- statuses: write
12
- name: Run CircleCI artifacts redirector
13
- steps:
14
- - name: GitHub Action step
15
- uses: scientific-python/circleci-artifacts-redirector-action@5d358ff96e96429a5c64a969bb4a574555439f4f # v1.3.1
16
- with:
17
- repo-token: ${{ secrets.GITHUB_TOKEN }}
18
- api-token: ${{ secrets.ASTROPY_SPHINX_CIRCLE_TOKEN }} # zizmor: ignore[secrets-outside-env]
19
- artifact-path: 0/docs/_build/html/index.html
20
- circleci-jobs: bootstrap-astropy,astropy-unified
21
- job-title: "--> Rendering Preview <--"
@@ -1,11 +0,0 @@
1
- :root {
2
- /* SunPy Theme Colors */
3
- --sst-accent-color-bright: #ff5000;
4
- --sst-accent-color-muted: #fc9468;
5
- --sst-dark-color: #404040;
6
- --sst-darker-color: #333333;
7
- --sst-darkest-color: #222222;
8
- --sst-light-color: rgb(206, 206, 206);
9
- --sst-lighter-color: rgb(231, 231, 231);
10
- --sst-lightest-color: rgb(251, 251, 251);
11
- }