bellingcat/auto-archiver
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver.git synced 2026-06-13 05:38:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst)

Browse Source
This commit is contained in:
Patrick Robertson
2025-02-10 16:24:16 +00:00
parent 63aba6ad39
commit 824728739a
24 changed files with 606 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/_templates/autoapi/index.rst vendored Normal file
View File

@@ -0,0 +1,34 @@
API Reference
=============
These pages are intended for developers of the `auto-archiver` package,
and include documentation on the core classes and functions used by
the auto-archiver
Core Classes
------------
.. toctree::
:titlesonly:
{% for page in pages|selectattr("is_top_level_object") %}
{% if page.name == 'core' %}
{{ page.include_path }}
{% endif %}
{% endfor %}
Util Functions
--------------
.. toctree::
:titlesonly:
{% for page in pages|selectattr("is_top_level_object") %}
{% if page.name == 'utils' %}
{{ page.include_path }}
{% endif %}
{% endfor %}