Rename _examples to examples for more legible URLs

PMEAL · Sep 7, 2022 · 7a2b598 · 7a2b598
1 parent def255b
commit 7a2b598
Show file tree

Hide file tree

Showing 9 changed files with 6 additions and 43 deletions.
diff --git 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 → docs/_examples/applications.rst b/docs/examples/applications.rst → docs/_examples/applications.rst
@@ -12,4 +12,4 @@ Applications
          :maxdepth: 1
          :glob:
 
-         ../_examples/applications/*
+         ../examples/applications/*
diff --git a/docs/examples/index.rst → docs/_examples/index.rst b/docs/examples/index.rst → docs/_examples/index.rst
diff --git a/docs/examples/reference.rst → docs/_examples/reference.rst b/docs/examples/reference.rst → docs/_examples/reference.rst
@@ -12,4 +12,4 @@ Reference
          :maxdepth: 1
          :glob:
 
-         ../_examples/reference/**
+         ../examples/reference/**
diff --git a/docs/examples/tutorials.rst → docs/_examples/tutorials.rst b/docs/examples/tutorials.rst → 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
@@ -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
@@ -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
diff --git a/docs/index.rst b/docs/index.rst
@@ -33,7 +33,6 @@ simulations.
    basic_usage
    modules/index
    examples/index
-   examples/index_old
 
 ----