change to doctest setup in sphinx

Author: TchilDill

docs/.DS_Store

@@ -31,7 +31,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
-    # "sphinx_copybutton",
+    "sphinx_copybutton",
     "sphinx.ext.doctest",
     "matplotlib.sphinxext.plot_directive",
 ]
@@ -55,6 +55,10 @@
 templates_path = ["_templates"]
 exclude_patterns = []
 
+#option for the copy button extension
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+
 # -- Options for LaTeX output ------------------------------------------------
 latex_engine = "pdflatex"
 numfig = True

docs/source/conf.py

@@ -17,39 +17,57 @@ Example 1 - Create a pile
 
 A pile can be created in the simple following way in openpile. 
 
-.. code-block:: python
-
-    from openpile.construct import Pile
+.. doctest::
 
-    # Create a pile instance with two sections of respectively 10m and 30m length.
-    pile = Pile(name = "",
-            kind='Circular',
-            material='Steel',
-            top_elevation = 0,
-            pile_sections={
-                'length':[10,30],
-                'diameter':[7.5,7.5],
-                'wall thickness':[0.07, 0.08],
-            }
-        )
+    >>> # import the Pile object from the construct module
+    >>> from openpile.construct import Pile
+    
+    >>> # Create a Pile
+    >>> pile = Pile(name = "",
+    ...         kind='Circular',
+    ...         material='Steel',
+    ...         top_elevation = 0,
+    ...         pile_sections={
+    ...             'length':[10,30],
+    ...             'diameter':[7.5,7.5],
+    ...             'wall thickness':[0.07, 0.08],
+    ...         }
+    ...     )
+
+    >>> # Print the pile data
+    >>> print(pile) # doctest: +NORMALIZE_WHITESPACE
+        Elevation [m]  Diameter [m]  Wall thickness [m]  Area [m2]     I [m4]
+    0            0.0           7.5                0.07   1.633942  11.276204
+    1          -10.0           7.5                0.07   1.633942  11.276204
+    2          -10.0           7.5                0.08   1.864849  12.835479
+    3          -40.0           7.5                0.08   1.864849  12.835479
+    >>>
 
 Additional methods can be used to create a Pile, these methods can shorten the lines of codes needed to create the pile.
 For instance:
 
-* :py:meth:`openpile.construct.Pile.create_tubular` which creates a circular pile of constant diameter.
+
+.. doctest::
+
+    >>> # Import Pile object from constuct module
+    >>> from openpile.construct import Pile
+
+    >>> # create pile
+    >>> p = Pile.create_tubular(
+    ...     name="<pile name>", top_elevation=0, bottom_elevation=-40, diameter=10, wt=0.050
+    ... )
+
+    >>> print(p)
+       Elevation [m]  Diameter [m]  Wall thickness [m]  Area [m2]     I [m4]
+    0            0.0          10.0                0.05   1.562942  19.342388
+    1          -40.0          10.0                0.05   1.562942  19.342388
+    >>> 
+
+
 
 Once the pile (object) is created, the user can use its properties and methods to interact with it. 
 A simple view of the pile can be extracted by printing the object as below: 
 
-.. code-block:: python
-    
-    # Print the pile data
-    print(pile)
-        Elevation [m]  Diameter [m]  Wall thickness [m]  Area [m2]     I [m4]
-    0            0.0           7.5                0.07   1.633942  11.276204
-    1          -10.0           7.5                0.07   1.633942  11.276204
-    2          -10.0           7.5                0.08   1.864849  12.835479
-    3          -40.0           7.5                0.08   1.864849  12.835479
 
 The user can also extract easily the pile length, elevations and other properties.
 Please see the :py:class:`openpile.construct.Pile`

docs/source/usage.rst

@@ -1,91 +1,122 @@
-alabaster==0.7.12
+alabaster==0.7.13
+anyio==3.6.2
+appnope==0.1.3
+argon2-cffi==21.3.0
+argon2-cffi-bindings==21.2.0
 attrs==22.2.0
-Babel==2.11.0
+autodoc-pydantic==1.9.0
+Babel==2.12.1
 backcall==0.2.0
+beautifulsoup4==4.12.2
 black==22.12.0
+bleach==6.0.0
 cachetools==5.3.0
 certifi==2022.12.7
+cffi==1.15.1
 chardet==5.1.0
-charset-normalizer==2.1.1
+charset-normalizer==3.1.0
 click==8.1.3
 colorama==0.4.6
-coverage==7.2.1
+coverage==7.2.2
 cycler==0.11.0
-debugpy==1.6.4
+debugpy==1.6.6
 decorator==5.1.1
 defusedxml==0.7.1
 distlib==0.3.6
-docutils==0.17.1
+docutils==0.18.1
 entrypoints==0.4
-exceptiongroup==1.1.0
-filelock==3.10.6
-flake8==5.0.4
-flake8-black==0.3.6
+exceptiongroup==1.1.1
+fastjsonschema==2.16.3
+filelock==3.10.7
 fonttools==4.38.0
-fpdf2==2.6.0
+fpdf2==2.7.1
 idna==3.4
 imagesize==1.4.1
-importlib-metadata==6.0.0
+importlib-metadata==6.1.0
+importlib-resources==5.12.0
 iniconfig==2.0.0
 ipykernel==6.16.2
 ipython==7.34.0
+ipython-genutils==0.2.0
 jedi==0.18.2
 Jinja2==3.1.2
-jupyter_client==7.4.8
-jupyter_core==4.12.0
+jsonschema==4.17.3
+jupyter-client==7.4.9
+jupyter-core==4.12.0
+jupyter-server==1.24.0
+jupyterlab-pygments==0.2.2
 kiwisolver==1.4.4
-line-profiler==4.0.3
 llvmlite==0.39.1
-MarkupSafe==2.1.1
+MarkupSafe==2.1.2
 matplotlib==3.5.3
 matplotlib-inline==0.1.6
-mccabe==0.7.0
+mistune==2.0.5
 mypy-extensions==1.0.0
+nbclassic==0.5.5
+nbclient==0.7.3
+nbconvert==7.3.1
+nbformat==5.8.0
 nest-asyncio==1.5.6
+notebook==6.5.4
+notebook-shim==0.2.2
 numba==0.56.4
 numpy==1.21.6
--e git+https://github.com/TchilDill/openpile.git
+-e git+https://github.com/TchilDill/openpile.git@e8aac1b7152a3ccbf6955d7df6f435d7f1ea753a#egg=openpile
 packaging==23.0
 pandas==1.3.5
+pandocfilters==1.5.0
 parso==0.8.3
 pathspec==0.11.1
+pexpect==4.8.0
 pickleshare==0.7.5
-Pillow==9.4.0
+Pillow==9.5.0
+pkgutil-resolve-name==1.3.10
 platformdirs==3.2.0
 pluggy==1.0.0
-prompt-toolkit==3.0.36
+prometheus-client==0.16.0
+prompt-toolkit==3.0.38
 psutil==5.9.4
-pycodestyle==2.9.1
-pydantic==1.10.4
-pyflakes==2.5.0
+ptyprocess==0.7.0
+pycparser==2.21
+pydantic==1.10.7
 Pygments==2.14.0
 pyparsing==3.0.9
-pyproject_api==1.5.1
-pytest==7.2.0
+pyproject-api==1.5.1
+pyrsistent==0.19.3
+pytest==7.2.2
 pytest-cov==4.0.0
+pytest-sphinx==0.5.0
 python-dateutil==2.8.2
-pytz==2022.7
-pywin32==305
+pytz==2023.3
 pyzmq==24.0.1
-requests==2.28.1
+requests==2.28.2
 scipy==1.7.3
+Send2Trash==1.8.0
 six==1.16.0
+sniffio==1.3.0
 snowballstemmer==2.2.0
-Sphinx==5.3.0
-sphinx-rtd-theme==1.1.1
+soupsieve==2.4
+sphinx==5.3.0
+sphinx-copybutton==0.5.2
+sphinx-rtd-theme==1.3.0
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
+terminado==0.17.1
+tinycss2==1.2.1
 tomli==2.0.1
 tornado==6.2
 tox==4.4.8
-traitlets==5.8.0
+traitlets==5.9.0
 typed-ast==1.5.4
-typing_extensions==4.5.0
-urllib3==1.26.13
+typing-extensions==4.5.0
+urllib3==1.26.15
 virtualenv==20.21.0
-wcwidth==0.2.5
-zipp==3.11.0
+wcwidth==0.2.6
+webencodings==0.5.1
+websocket-client==1.5.1
+zipp==3.15.0