From 1e1cd69146d34875b1adf9ea334e7201404fbe9f Mon Sep 17 00:00:00 2001 From: mdtanker Date: Wed, 16 Jul 2025 09:56:09 +0200 Subject: [PATCH] start switching to jupyter book --- CONTRIBUTING.md | 2 +- docs/api/packagename.rst | 18 ------------------ docs/api/samplepackagename.rst | 18 ------------------ 3 files changed, 1 insertion(+), 37 deletions(-) delete mode 100644 docs/api/packagename.rst delete mode 100644 docs/api/samplepackagename.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0aedc60..dae9395 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -275,7 +275,7 @@ Leave a comment in the PR and we'll help you out. ### Documentation -The Docs are build with `Sphinx` and `Read the Docs`. +The Docs are build with [Jupyer Book](https://jupyterbook.org/en/stable/intro.html) and hosted on [Read the Docs](https://readthedocs.org/). > **Note:** The docs are automatically built on PR's by `RTD`, but it's good practice to build them manually before a PR, to check them for errors. diff --git a/docs/api/packagename.rst b/docs/api/packagename.rst deleted file mode 100644 index 894c628..0000000 --- a/docs/api/packagename.rst +++ /dev/null @@ -1,18 +0,0 @@ -samplepackagename package -=================== - -.. automodule:: samplepackagename - :members: - :show-inheritance: - :undoc-members: - -Submodules ----------- - -samplepackagename.module1 module --------------------------- - -.. automodule:: samplepackagename.module1 - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/api/samplepackagename.rst b/docs/api/samplepackagename.rst deleted file mode 100644 index 8f56933..0000000 --- a/docs/api/samplepackagename.rst +++ /dev/null @@ -1,18 +0,0 @@ -samplepackagename package -========================= - -.. automodule:: samplepackagename - :members: - :show-inheritance: - :undoc-members: - -Submodules ----------- - -samplepackagename.module1 module --------------------------------- - -.. automodule:: samplepackagename.module1 - :members: - :show-inheritance: - :undoc-members: