From d71a33bb3310106b1e2c34ed380213e3fa423d69 Mon Sep 17 00:00:00 2001 From: InsanePrawn Date: Sun, 17 Mar 2024 17:39:44 +0100 Subject: [PATCH] docs: WIP --- docs/.gitignore | 1 + docs/source/code.md | 9 +++++++++ docs/source/codegen.rst | 8 ++++++++ docs/source/genindex.rst | 2 ++ docs/source/templates/code.rst | 36 ++++++++++++++++++++++++++++++++++ 5 files changed, 56 insertions(+) create mode 100644 docs/source/code.md create mode 100644 docs/source/codegen.rst create mode 100644 docs/source/genindex.rst create mode 100644 docs/source/templates/code.rst diff --git a/docs/.gitignore b/docs/.gitignore index 5d14997..b0fd27d 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,6 +2,7 @@ .doctrees html source/cli +source/code checkouts versions archived diff --git a/docs/source/code.md b/docs/source/code.md new file mode 100644 index 0000000..fb15e4a --- /dev/null +++ b/docs/source/code.md @@ -0,0 +1,9 @@ +# Code + +Code documentation is available here + +```{toctree} +:glob: true + +code/kupferbootstrap +``` diff --git a/docs/source/codegen.rst b/docs/source/codegen.rst new file mode 100644 index 0000000..13a4cc5 --- /dev/null +++ b/docs/source/codegen.rst @@ -0,0 +1,8 @@ +:nosearch: +:orphan: + +.. autosummary:: + :toctree: code + :recursive: + + kupferbootstrap diff --git a/docs/source/genindex.rst b/docs/source/genindex.rst new file mode 100644 index 0000000..f6c180c --- /dev/null +++ b/docs/source/genindex.rst @@ -0,0 +1,2 @@ +Module Index +============ diff --git a/docs/source/templates/code.rst b/docs/source/templates/code.rst new file mode 100644 index 0000000..fb116ef --- /dev/null +++ b/docs/source/templates/code.rst @@ -0,0 +1,36 @@ +{% set reduced_name = fullname.split(".", 1)[-1] if fullname.startswith("kupferbootstrap.") else fullname %} + +{{ fullname | escape | underline }} + +.. rubric:: Description + +.. automodule:: {{ fullname }} + :members: + :undoc-members: + +.. currentmodule:: {{ fullname }} + + + + +{% if classes %} +.. rubric:: Classes + +.. autosummary:: + :toctree: . + {% for class in classes %} + {{ class }} + {% endfor %} + +{% endif %} + +{% if functions %} +.. rubric:: Functions + +.. autosummary:: + :toctree: . + {% for function in functions %} + {{ function }} + {% endfor %} + +{% endif %}