summaryrefslogtreecommitdiffstatshomepage
path: root/docs/plugins/writing/reference.rst
diff options
context:
space:
mode:
authorWolfgang Müller2024-03-05 18:08:09 +0100
committerWolfgang Müller2024-03-05 19:25:59 +0100
commitd1d654ebac2d51e3841675faeb56480e440f622f (patch)
tree56ef123c1a15a10dfd90836e4038e27efde950c6 /docs/plugins/writing/reference.rst
downloadhircine-0.1.0.tar.gz
Initial commit0.1.0
Diffstat (limited to '')
-rw-r--r--docs/plugins/writing/reference.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/plugins/writing/reference.rst b/docs/plugins/writing/reference.rst
new file mode 100644
index 0000000..1be281e
--- /dev/null
+++ b/docs/plugins/writing/reference.rst
@@ -0,0 +1,51 @@
+Plugin API Reference
+====================
+
+.. _scraped-data:
+
+Scraped Data
+------------
+
+.. automodule:: hircine.scraper.types
+ :members:
+
+API Data
+--------
+
+.. autoclass:: hircine.api.types.FullComic
+ :members:
+ :inherited-members:
+ :undoc-members:
+ :exclude-members: cover
+
+.. autoclass:: hircine.api.types.Archive
+ :members:
+ :undoc-members:
+ :exclude-members: cover
+
+Enums
+-----
+
+.. autoclass:: hircine.enums.Category()
+ :members:
+ :undoc-members:
+
+.. autoclass:: hircine.enums.Censorship()
+ :members:
+ :undoc-members:
+
+.. autoclass:: hircine.enums.Direction()
+ :members:
+ :undoc-members:
+
+.. autoclass:: hircine.enums.Language()
+ :members:
+ :undoc-members:
+
+.. autoclass:: hircine.enums.Layout()
+ :members:
+ :undoc-members:
+
+.. autoclass:: hircine.enums.Rating()
+ :members:
+ :undoc-members: