docs: WIP

This commit is contained in:
InsanePrawn 2024-03-17 17:39:44 +01:00
parent 3ffe702301
commit d71a33bb33
5 changed files with 56 additions and 0 deletions

1
docs/.gitignore vendored
View file

@ -2,6 +2,7 @@
.doctrees
html
source/cli
source/code
checkouts
versions
archived

9
docs/source/code.md Normal file
View file

@ -0,0 +1,9 @@
# Code
Code documentation is available here
```{toctree}
:glob: true
code/kupferbootstrap
```

8
docs/source/codegen.rst Normal file
View file

@ -0,0 +1,8 @@
:nosearch:
:orphan:
.. autosummary::
:toctree: code
:recursive:
kupferbootstrap

2
docs/source/genindex.rst Normal file
View file

@ -0,0 +1,2 @@
Module Index
============

View file

@ -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 %}