diff --git a/demo/demo.ipynb b/docs/pg-rad-in-python.ipynb similarity index 100% rename from demo/demo.ipynb rename to docs/pg-rad-in-python.ipynb diff --git a/docs/pg-rad-in-python.md b/docs/pg-rad-in-python.md deleted file mode 100644 index 8332390..0000000 --- a/docs/pg-rad-in-python.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Using PG-RAD as a module ---- - -Consult the API documentation in the side bar. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 659692d..afa1ca7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,8 +28,15 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.superfences + - pymdownx.arithmatex: + generic: true + +extra_javascript: + - javascripts/mathjax.js + - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js plugins: +- mkdocs-jupyter - mkdocstrings: enabled: !ENV [ENABLE_MKDOCSTRINGS, true] default_handler: python diff --git a/pyproject.toml b/pyproject.toml index 033bb38..e187ba3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,4 +29,4 @@ Homepage = "https://github.com/pim-n/pg-rad" Issues = "https://github.com/pim-n/pg-rad/issues" [project.optional-dependencies] -dev = ["pytest", "notebook", "mkdocs-material", "mkdocstrings-python"] \ No newline at end of file +dev = ["pytest", "notebook", "mkdocs-material", "mkdocstrings-python", "mkdocs-jupyter"] \ No newline at end of file