Skip to content

Commit 1b22fb2

Browse files
committed
Sphinx gallery
1 parent 7fb2919 commit 1b22fb2

13 files changed

+18
-249
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ coverage.xml
4242

4343
# Sphinx documentation
4444
docs/_build/
45+
docs/built_examples/
4546

4647
# Jupyter Notebook
4748
.ipynb_checkpoints
-2.04 KB
Binary file not shown.
-1.09 KB
Binary file not shown.
Binary file not shown.

docs/built_examples/index.rst

-59
This file was deleted.

docs/built_examples/sample.ipynb

-54
This file was deleted.

docs/built_examples/sample.rst

-87
This file was deleted.
-479 Bytes
Binary file not shown.

docs/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
3333
extensions = ['sphinx_gallery.gen_gallery',
34+
"myst_parser"
3435
]
3536

3637
# Sphinx gallery
File renamed without changes.

docs/examples/sample.py

-37
This file was deleted.

docs/index.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
.. examplePy documentation master file, created by
2-
sphinx-quickstart on Wed Dec 28 10:33:20 2022.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
# Welcome to examplePy's documentation!
52

6-
Welcome to examplePy's documentation!
7-
=====================================
83

9-
.. toctree::
10-
:maxdepth: 2
11-
:caption: Contents:
4+
```{toctree}
5+
:hidden:
6+
:caption: Example
127
8+
Home <self>
9+
gallery <built_examples/index>
10+
```
1311

1412

15-
Indices and tables
13+
14+
<!-- Indices and tables
1615
==================
1716
1817
* :ref:`genindex`
1918
* :ref:`modindex`
20-
* :ref:`search`
19+
* :ref:`search` -->

requirements.txt

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11

22
# for sphinx gallery only
33
sphinx-gallery
4-
pillow
4+
pillow
5+
seaborn
6+
7+
# theme and syntax
8+
myst_parser
9+
furo

0 commit comments

Comments
 (0)