diff --git a/.gitignore b/.gitignore index 5fae9448de5..c3bbdc79eb4 100644 --- a/.gitignore +++ b/.gitignore @@ -27,14 +27,14 @@ tmp-test-dir-with-unique-name/ # Sphinx documentation doc/api/generated/ doc/_build/ +doc/intro/ +doc/tutorials/ doc/gallery/ doc/projections/ -doc/tutorials/ -doc/get_started/ # doc/sg_execution_time.rst is auto-generated by Sphinx-Gallery doc/sg_execution_times.rst -# Jupyter Notebook +# Jupyter notebook .ipynb_checkpoints/ # Visual Studio Code diff --git a/doc/Makefile b/doc/Makefile index aab41e56727..63ecd10f5ac 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -55,7 +55,7 @@ server: clean: rm -rf $(BUILDDIR) rm -rf api/generated - rm -rf gallery + rm -rf intro rm -rf tutorials - rm -rf get_started + rm -rf gallery rm -rf projections diff --git a/doc/conf.py b/doc/conf.py index 5f9c7469107..1586601804d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -103,15 +103,18 @@ sphinx_gallery_conf = { # Set paths to your examples scripts "examples_dirs": [ - "../examples/gallery", + "../examples/intro", "../examples/tutorials", - "../examples/get_started", + "../examples/gallery", "../examples/projections", ], # Set paths where to save the generated examples - "gallery_dirs": ["gallery", "tutorials", "get_started", "projections"], + "gallery_dirs": ["intro", "tutorials", "gallery", "projections"], "subsection_order": ExplicitOrder( [ + "../examples/intro", + "../examples/tutorials/basics", + "../examples/tutorials/advanced", "../examples/gallery/maps", "../examples/gallery/lines", "../examples/gallery/symbols", @@ -127,9 +130,6 @@ "../examples/projections/misc", "../examples/projections/nongeo", "../examples/projections/table", - "../examples/tutorials/basics", - "../examples/tutorials/advanced", - "../examples/get_started", ] ), # Pattern to search for example files @@ -159,13 +159,13 @@ "**.ipynb_checkpoints", # Workaround from https://github.com/executablebooks/MyST-NB/issues/363 to prevent # MyST-NB from parsing the .ipynb and .py files generated by Sphinx-Gallery. - "gallery/**.ipynb", + "intro/**.ipynb", "tutorials/**.ipynb", - "get_started/**.ipynb", + "gallery/**.ipynb", "projections/**.ipynb", - "gallery/**.py", + "intro/**.py", "tutorials/**.py", - "get_started/**.py", + "gallery/**.py", "projections/**.py", ] diff --git a/doc/index.md b/doc/index.md index 94b21a0d1fb..d04a4353182 100644 --- a/doc/index.md +++ b/doc/index.md @@ -22,7 +22,7 @@ overview.md install.md -get_started/index.rst +intro/index.rst ``` ```{toctree} @@ -39,7 +39,7 @@ external_resources.md ```{toctree} :maxdepth: 2 :hidden: -:caption: Reference documentation +:caption: Reference Documentation api/index.rst techref/index.md diff --git a/examples/get_started/01_first_figure.py b/examples/intro/01_first_figure.py similarity index 100% rename from examples/get_started/01_first_figure.py rename to examples/intro/01_first_figure.py diff --git a/examples/get_started/02_contour_map.py b/examples/intro/02_contour_map.py similarity index 100% rename from examples/get_started/02_contour_map.py rename to examples/intro/02_contour_map.py diff --git a/examples/get_started/03_figure_element.py b/examples/intro/03_figure_element.py similarity index 100% rename from examples/get_started/03_figure_element.py rename to examples/intro/03_figure_element.py diff --git a/examples/get_started/04_table_inputs.py b/examples/intro/04_table_inputs.py similarity index 100% rename from examples/get_started/04_table_inputs.py rename to examples/intro/04_table_inputs.py diff --git a/examples/get_started/GALLERY_HEADER.rst b/examples/intro/GALLERY_HEADER.rst similarity index 100% rename from examples/get_started/GALLERY_HEADER.rst rename to examples/intro/GALLERY_HEADER.rst