From 3f203668e5f4b3f3b2cf454705ac140dc6601932 Mon Sep 17 00:00:00 2001
From: Pierre-antoine Comby <pierre-antoine.comby@crans.org>
Date: Tue, 14 May 2024 18:45:47 +0200
Subject: [PATCH] cleanup the documentation

---
 docs/_templates/module.rst_t  |  8 -----
 docs/_templates/package.rst_t | 57 -----------------------------------
 docs/build_docs.sh            |  2 +-
 3 files changed, 1 insertion(+), 66 deletions(-)
 delete mode 100644 docs/_templates/module.rst_t
 delete mode 100644 docs/_templates/package.rst_t

diff --git a/docs/_templates/module.rst_t b/docs/_templates/module.rst_t
deleted file mode 100644
index 2644b73..0000000
--- a/docs/_templates/module.rst_t
+++ /dev/null
@@ -1,8 +0,0 @@
-{%- if show_headings %}
-{{- [basename] | join(' ') | e | heading }}
-
-{% endif -%}
-.. automodule:: {{ qualname }}
-{%- for option in automodule_options %}
-   :{{ option }}:
-{%- endfor %}
diff --git a/docs/_templates/package.rst_t b/docs/_templates/package.rst_t
deleted file mode 100644
index 0e398a7..0000000
--- a/docs/_templates/package.rst_t
+++ /dev/null
@@ -1,57 +0,0 @@
-{%- macro automodule(modname, options) -%}
-.. automodule:: {{ modname }}
-{%- for option in options %}
-   :{{ option }}:
-{%- endfor %}
-{%- endmacro %}
-
-{%- macro toctree(docnames) -%}
-.. toctree::
-   :maxdepth: {{ maxdepth }}
-{% for docname in docnames %}
-   {{ docname }}
-{%- endfor %}
-{%- endmacro %}
-
-{%- if is_namespace %}
-{{- ("``" ~ pkgname ~ "``") | heading }}
-{% else %}
-{{- ("``" ~ pkgname ~"``") | heading }}
-{% endif %}
-
-{%- if is_namespace %}
-.. py:module:: {{ pkgname }}
-{% endif %}
-
-{%- if modulefirst and not is_namespace %}
-{{ automodule(pkgname, automodule_options) }}
-{% endif %}
-
-{%- if subpackages %}
-Subpackages
------------
-
-{{ toctree(subpackages) }}
-{% endif %}
-
-{%- if submodules %}
-Submodules
-----------
-{% if separatemodules %}
-{{ toctree(submodules) }}
-{% else %}
-{%- for submodule in submodules %}
-{% if show_headings %}
-{{- [submodule, "module"] | join(" ") | e | heading(2) }}
-{% endif %}
-{{ automodule(submodule, automodule_options) }}
-{% endfor %}
-{%- endif %}
-{%- endif %}
-
-{%- if not modulefirst and not is_namespace %}
-Module contents
----------------
-
-{{ automodule(pkgname, automodule_options) }}
-{% endif %}
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
index ea3e0cf..b238649 100755
--- a/docs/build_docs.sh
+++ b/docs/build_docs.sh
@@ -3,7 +3,7 @@
 rm -rf _build _api
 
 # Build the API documentation with autoapi
-sphinx-apidoc -ePf --ext-autodoc --output-dir=_api -t _templates/ ../src/snkf  "**/_version.py"
+#sphinx-apidoc -ePf --ext-autodoc --output-dir=_api -t _templates/ ../src/snkf  "**/_version.py"
 
 # Finally build the entire docs
 jupyter-book build .