sphinx-examples-as-code 0.6.0__tar.gz → 0.6.1__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.
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/.github/workflows/ci.yml +2 -2
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/PKG-INFO +13 -3
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/README.md +10 -2
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/pyproject.toml +3 -1
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/_version.py +3 -3
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/PKG-INFO +13 -3
- sphinx_examples_as_code-0.6.1/sphinx_examples_as_code.egg-info/requires.txt +4 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/scm_version.json +2 -2
- sphinx_examples_as_code-0.6.0/sphinx_examples_as_code.egg-info/requires.txt +0 -1
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/.github/dependabot.yml +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/.github/release.yml +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/.gitignore +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/.pre-commit-config.yaml +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/LICENSE +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/setup.cfg +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/__init__.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/SOURCES.txt +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/dependency_links.txt +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/scm_file_list.json +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code.egg-info/top_level.txt +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/conf.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/examples/GALLERY_HEADER.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/examples/plot_minimal.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/index.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/conf.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/examples/GALLERY_HEADER.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/examples/plot_reused_level.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/examples/plot_three_levels.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/index.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/single_function_fixture/conf.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/single_function_fixture/index.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/single_function_fixture/mymodule.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_gallery_downloads.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_heading_level_reuse.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_single_function_page.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_sphinx_examples_as_code.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_tinypages.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/conf.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.py +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.rst +0 -0
- {sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/index.rst +0 -0
|
@@ -25,7 +25,7 @@ jobs:
|
|
|
25
25
|
- uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
|
26
26
|
with:
|
|
27
27
|
enable-cache: false
|
|
28
|
-
- run: uv sync --group dev
|
|
28
|
+
- run: uv sync --group dev --extra gallery
|
|
29
29
|
- run: uv run pre-commit run --all-files --show-diff-on-failure
|
|
30
30
|
env:
|
|
31
31
|
# This hook exists to stop *local* commits straight to main; it
|
|
@@ -49,7 +49,7 @@ jobs:
|
|
|
49
49
|
- uses: pyvista/setup-headless-display-action@c103a2ff45650d38cb71684b5dc6cdfeb9442c79 # v5.1.0
|
|
50
50
|
with:
|
|
51
51
|
pyvista: true
|
|
52
|
-
- run: uv sync --group dev --python ${{ matrix.python-version }}
|
|
52
|
+
- run: uv sync --group dev --extra gallery --python ${{ matrix.python-version }}
|
|
53
53
|
- run: uv run pytest tests/ --cov --cov-report=xml
|
|
54
54
|
- uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
|
|
55
55
|
with:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sphinx-examples-as-code
|
|
3
|
-
Version: 0.6.
|
|
3
|
+
Version: 0.6.1
|
|
4
4
|
Summary: Sphinx extension for converting docstring examples into downloadable code.
|
|
5
5
|
Author-email: The PyVista Developers <info@pyvista.org>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -23,6 +23,8 @@ Requires-Python: >=3.10
|
|
|
23
23
|
Description-Content-Type: text/markdown
|
|
24
24
|
License-File: LICENSE
|
|
25
25
|
Requires-Dist: pyvista>=0.48
|
|
26
|
+
Provides-Extra: gallery
|
|
27
|
+
Requires-Dist: sphinx-gallery<0.23,>=0.22; extra == "gallery"
|
|
26
28
|
Dynamic: license-file
|
|
27
29
|
|
|
28
30
|
# sphinx-examples-as-code
|
|
@@ -39,6 +41,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
|
|
|
39
41
|
pip install sphinx-examples-as-code
|
|
40
42
|
```
|
|
41
43
|
|
|
44
|
+
Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
|
|
45
|
+
`gallery` extra pins:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install 'sphinx-examples-as-code[gallery]'
|
|
49
|
+
```
|
|
50
|
+
|
|
42
51
|
Add it to your Sphinx `conf.py`:
|
|
43
52
|
|
|
44
53
|
```python
|
|
@@ -182,14 +191,15 @@ Two things worth knowing before turning this on:
|
|
|
182
191
|
- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
|
|
183
192
|
its own theming depends on, and the private node type holding a highlighted code
|
|
184
193
|
block — not a documented extension API. A future sphinx-gallery release could shift
|
|
185
|
-
that structure without warning.
|
|
194
|
+
that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
|
|
195
|
+
extra caps there rather than letting the next release quietly produce no downloads.
|
|
186
196
|
- sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
|
|
187
197
|
`_downloads/`, even though nothing on the page links to them anymore.
|
|
188
198
|
|
|
189
199
|
## Development
|
|
190
200
|
|
|
191
201
|
```bash
|
|
192
|
-
uv sync --group dev
|
|
202
|
+
uv sync --group dev --extra gallery
|
|
193
203
|
uv run pytest
|
|
194
204
|
uv run pre-commit run --all-files
|
|
195
205
|
```
|
|
@@ -12,6 +12,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
|
|
|
12
12
|
pip install sphinx-examples-as-code
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
|
|
16
|
+
`gallery` extra pins:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pip install 'sphinx-examples-as-code[gallery]'
|
|
20
|
+
```
|
|
21
|
+
|
|
15
22
|
Add it to your Sphinx `conf.py`:
|
|
16
23
|
|
|
17
24
|
```python
|
|
@@ -155,14 +162,15 @@ Two things worth knowing before turning this on:
|
|
|
155
162
|
- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
|
|
156
163
|
its own theming depends on, and the private node type holding a highlighted code
|
|
157
164
|
block — not a documented extension API. A future sphinx-gallery release could shift
|
|
158
|
-
that structure without warning.
|
|
165
|
+
that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
|
|
166
|
+
extra caps there rather than letting the next release quietly produce no downloads.
|
|
159
167
|
- sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
|
|
160
168
|
`_downloads/`, even though nothing on the page links to them anymore.
|
|
161
169
|
|
|
162
170
|
## Development
|
|
163
171
|
|
|
164
172
|
```bash
|
|
165
|
-
uv sync --group dev
|
|
173
|
+
uv sync --group dev --extra gallery
|
|
166
174
|
uv run pytest
|
|
167
175
|
uv run pre-commit run --all-files
|
|
168
176
|
```
|
|
@@ -11,7 +11,6 @@ dev = [
|
|
|
11
11
|
'pytest-cov',
|
|
12
12
|
'sphinx',
|
|
13
13
|
'sphinx-design',
|
|
14
|
-
'sphinx-gallery>=0.22',
|
|
15
14
|
'trame-pyvista',
|
|
16
15
|
]
|
|
17
16
|
|
|
@@ -41,6 +40,9 @@ name = 'sphinx-examples-as-code'
|
|
|
41
40
|
readme = 'README.md'
|
|
42
41
|
requires-python = '>=3.10'
|
|
43
42
|
|
|
43
|
+
[project.optional-dependencies]
|
|
44
|
+
gallery = ['sphinx-gallery>=0.22,<0.23']
|
|
45
|
+
|
|
44
46
|
[project.urls]
|
|
45
47
|
Homepage = 'https://github.com/pyvista/sphinx-examples-as-code'
|
|
46
48
|
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/_version.py
RENAMED
|
@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
|
|
|
18
18
|
commit_id: str | None
|
|
19
19
|
__commit_id__: str | None
|
|
20
20
|
|
|
21
|
-
__version__ = version = '0.6.
|
|
22
|
-
__version_tuple__ = version_tuple = (0, 6,
|
|
21
|
+
__version__ = version = '0.6.1'
|
|
22
|
+
__version_tuple__ = version_tuple = (0, 6, 1)
|
|
23
23
|
|
|
24
|
-
__commit_id__ = commit_id = '
|
|
24
|
+
__commit_id__ = commit_id = 'ge9f0565b9'
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sphinx-examples-as-code
|
|
3
|
-
Version: 0.6.
|
|
3
|
+
Version: 0.6.1
|
|
4
4
|
Summary: Sphinx extension for converting docstring examples into downloadable code.
|
|
5
5
|
Author-email: The PyVista Developers <info@pyvista.org>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -23,6 +23,8 @@ Requires-Python: >=3.10
|
|
|
23
23
|
Description-Content-Type: text/markdown
|
|
24
24
|
License-File: LICENSE
|
|
25
25
|
Requires-Dist: pyvista>=0.48
|
|
26
|
+
Provides-Extra: gallery
|
|
27
|
+
Requires-Dist: sphinx-gallery<0.23,>=0.22; extra == "gallery"
|
|
26
28
|
Dynamic: license-file
|
|
27
29
|
|
|
28
30
|
# sphinx-examples-as-code
|
|
@@ -39,6 +41,13 @@ Pages or docstrings without an Examples section are left completely untouched. A
|
|
|
39
41
|
pip install sphinx-examples-as-code
|
|
40
42
|
```
|
|
41
43
|
|
|
44
|
+
Sphinx-Gallery integration is opt-in and needs a compatible sphinx-gallery, which the
|
|
45
|
+
`gallery` extra pins:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install 'sphinx-examples-as-code[gallery]'
|
|
49
|
+
```
|
|
50
|
+
|
|
42
51
|
Add it to your Sphinx `conf.py`:
|
|
43
52
|
|
|
44
53
|
```python
|
|
@@ -182,14 +191,15 @@ Two things worth knowing before turning this on:
|
|
|
182
191
|
- It's built against sphinx-gallery's own doctree output — the `sphx-glr-*` CSS classes
|
|
183
192
|
its own theming depends on, and the private node type holding a highlighted code
|
|
184
193
|
block — not a documented extension API. A future sphinx-gallery release could shift
|
|
185
|
-
that structure without warning.
|
|
194
|
+
that structure without warning. Only sphinx-gallery 0.22.x is tested, so the `gallery`
|
|
195
|
+
extra caps there rather than letting the next release quietly produce no downloads.
|
|
186
196
|
- sphinx-gallery's own `.py`/`.ipynb`/`.zip` downloads still end up copied into
|
|
187
197
|
`_downloads/`, even though nothing on the page links to them anymore.
|
|
188
198
|
|
|
189
199
|
## Development
|
|
190
200
|
|
|
191
201
|
```bash
|
|
192
|
-
uv sync --group dev
|
|
202
|
+
uv sync --group dev --extra gallery
|
|
193
203
|
uv run pytest
|
|
194
204
|
uv run pre-commit run --all-files
|
|
195
205
|
```
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
pyvista>=0.48
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/sphinx_examples_as_code/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/conf.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/gallery_fixture/index.rst
RENAMED
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/heading_level_fixture/conf.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_gallery_downloads.py
RENAMED
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_heading_level_reuse.py
RENAMED
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/test_single_function_page.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.py
RENAMED
|
File without changes
|
{sphinx_examples_as_code-0.6.0 → sphinx_examples_as_code-0.6.1}/tests/tinypages/docstring_cases.rst
RENAMED
|
File without changes
|
|
File without changes
|