From 7a2b598e57481daddb92763d9720ac7e3fe1dcf6 Mon Sep 17 00:00:00 2001 From: Amin Sadeghi Date: Tue, 6 Sep 2022 22:39:23 -0400 Subject: [PATCH] Rename _examples to examples for more legible URLs --- .gitignore | 2 +- docs/{examples => _examples}/applications.rst | 2 +- docs/{examples => _examples}/index.rst | 0 docs/{examples => _examples}/reference.rst | 2 +- docs/{examples => _examples}/tutorials.rst | 2 +- docs/basic_usage.rst | 2 +- docs/conf.py | 2 +- docs/examples/index_old.rst | 36 ------------------- docs/index.rst | 1 - 9 files changed, 6 insertions(+), 43 deletions(-) rename docs/{examples => _examples}/applications.rst (81%) rename docs/{examples => _examples}/index.rst (100%) rename docs/{examples => _examples}/reference.rst (80%) rename docs/{examples => _examples}/tutorials.rst (85%) delete mode 100644 docs/examples/index_old.rst diff --git a/.gitignore b/.gitignore index 211cfa1005..c12ec69b41 100644 --- a/.gitignore +++ b/.gitignore @@ -154,7 +154,7 @@ public/ # Sphinx docs **/generated -docs/_examples +docs/examples openpnm/core/.DS_Store */.DS_Store *.DS_Store diff --git a/docs/examples/applications.rst b/docs/_examples/applications.rst similarity index 81% rename from docs/examples/applications.rst rename to docs/_examples/applications.rst index 4dd0d6150e..0341d3817e 100644 --- a/docs/examples/applications.rst +++ b/docs/_examples/applications.rst @@ -12,4 +12,4 @@ Applications :maxdepth: 1 :glob: - ../_examples/applications/* + ../examples/applications/* diff --git a/docs/examples/index.rst b/docs/_examples/index.rst similarity index 100% rename from docs/examples/index.rst rename to docs/_examples/index.rst diff --git a/docs/examples/reference.rst b/docs/_examples/reference.rst similarity index 80% rename from docs/examples/reference.rst rename to docs/_examples/reference.rst index d05efbf297..02a673e51a 100644 --- a/docs/examples/reference.rst +++ b/docs/_examples/reference.rst @@ -12,4 +12,4 @@ Reference :maxdepth: 1 :glob: - ../_examples/reference/** + ../examples/reference/** diff --git a/docs/examples/tutorials.rst b/docs/_examples/tutorials.rst similarity index 85% rename from docs/examples/tutorials.rst rename to docs/_examples/tutorials.rst index add568d9d9..3354741ef6 100644 --- a/docs/examples/tutorials.rst +++ b/docs/_examples/tutorials.rst @@ -12,4 +12,4 @@ :maxdepth: 1 :glob: - ../_examples/tutorials/* + ../examples/tutorials/* diff --git a/docs/basic_usage.rst b/docs/basic_usage.rst index 81907f76d5..04108fc598 100644 --- a/docs/basic_usage.rst +++ b/docs/basic_usage.rst @@ -93,4 +93,4 @@ later. Now you can run ``geo.show_hist(['pore.old_diameter', 'pore.diameter'])`` to get a quick glance at the histograms of the two distributions. -More complex tasks are explained in the :doc:`examples <../examples/index>` page. +More complex tasks are explained in the :doc:`examples <../_examples/index>` page. diff --git a/docs/conf.py b/docs/conf.py index 42ba6076cc..0813060547 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ # Copy examples folder from OpenPNM root to docs folder import shutil -shutil.copytree('../examples', '_examples', dirs_exist_ok=True) +shutil.copytree('../examples', 'examples', dirs_exist_ok=True) #------------------------------------------------------------------------# # General config # diff --git a/docs/examples/index_old.rst b/docs/examples/index_old.rst deleted file mode 100644 index 12448fa557..0000000000 --- a/docs/examples/index_old.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _examples_old: - -############## -Examples (old) -############## - -The best way to learn OpenPNM (like anything) is to experiment. -In this page, you can find lots of examples that will help you get started. -The examples are categorized into the following categories: - -Reference ---------- - -.. tab-set:: - - .. tab-item:: Uncategorized - - .. toctree:: - :maxdepth: 1 - :glob: - - ../_examples/reference/uncategorized/* - - -Simulations ------------ - -.. tab-set:: - - .. tab-item:: Simulations - - .. toctree:: - :maxdepth: 1 - :glob: - - ../_examples/reference/simulations/* diff --git a/docs/index.rst b/docs/index.rst index 021803ac85..d60d55b0c2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,6 @@ simulations. basic_usage modules/index examples/index - examples/index_old ----