Finalize

docs/README.md

@@ -6,6 +6,8 @@ To generate a local copy of the documentation, make sure you've installed poetry
 poetry install --with docs
 ```
 
+Additionally, `pandoc` needs to be installed: https://pandoc.org/installing.html
+
 Then navigate to this directory and run:
 
 ```

docs/conf.py

@@ -59,6 +59,10 @@
 
 # -- Notebook rendering -------------------------------------------------
 
+# Something to consider: https://dokk.org/documentation/nbsphinx/0.9.3/prolog-and-epilog/
+nbsphinx_epilog = """"""
+nbsphinx_prolog = """"""
+
 nbsphinx_custom_formats = {
     ".pct.py": ["jupytext.reads", {"fmt": "py:percent"}],
 }

docs/examples/30_degree_rule.pct.py

@@ -1,6 +1,15 @@
 # %% [markdown]
 # # 30-degree rule
 #
+# NOTE: THIS IS JUST A TEST
+#
+# $\exp{10} = A_{i}$
+#
+# $$
+# \text{XXX} = \cos{2\pi}
+# $$
+#
+#
 # """This script validates the 30-degree rule proposed by Dr. Dave Billiards
 #
 # For more information about the 30-degree rule, see https://billiards.colostate.edu/faq/30-90-rules/30-degree-rule/
@@ -12,7 +21,6 @@
 import plotly.express as px
 import plotly.io as pio
 
-# %%
 import pooltool as pt
 import pooltool.constants as constants
 

docs/examples/README.md

@@ -0,0 +1,7 @@
+# Summary
+
+All the examples are jupyter notebooks represented in percent format: https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-percent-format
+
+They can be opened as notebooks by running `jupyter lab`, right clicking the file, and selecting "Open as notebook"
+
+If you have a notebook, and would like to add it to the documentation, convert it to the percent format `jupytext --sync <yours.ipynb>`. It must be suffixed with `.pct.py`. Then open `index.md` and add it.

docs/examples/index.md

@@ -1,11 +1,8 @@
 # Examples
 
-## Contents
-
 ```{eval-rst}
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    30_degree_rule
 ```