Skip to content

Commit

Permalink
Moving getting started to the examples section
Browse files Browse the repository at this point in the history
  • Loading branch information
jgostick committed Jul 22, 2023
1 parent 9847958 commit dd599d9
Show file tree
Hide file tree
Showing 6 changed files with 330 additions and 99 deletions.
1 change: 1 addition & 0 deletions docs/_examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The examples are categorized into the following categories:
.. toctree::
:maxdepth: 2

../examples/getting_started
tutorials
applications
reference
96 changes: 0 additions & 96 deletions docs/basic_usage.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ simulations.
:maxdepth: 0

installation
basic_usage
modules/index
_examples/index

Expand Down
1 change: 0 additions & 1 deletion docs/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ Module Reference
openpnm.algorithms
openpnm.topotools
openpnm.io
openpnm.metrics
328 changes: 328 additions & 0 deletions examples/basic_usage.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst-nb
numpydoc
pandoc
plotly
pydata-sphinx-theme=0.9
pydata-sphinx-theme
sphinx
sphinx-copybutton
sphinx-design

0 comments on commit dd599d9

Please sign in to comment.