document BlockEncoder and BlockDecoder

2024-09-13 06:37:34 +00:00 · 2021-03-21 02:10:28 -07:00 · 2021-03-21 02:10:28 -07:00 · 7c91139775
commit 7c91139775
parent 920bc8d9fe
4 changed files with 20 additions and 2 deletions
--- a/docs/reference/conversion.rst
+++ b/docs/reference/conversion.rst
@ -0,0 +1,10 @@
+.. py:currentmodule:: quicktex
+
+Conversion
+============
+
+.. autoclass:: BlockEncoder
+    :members:
+
+.. autoclass:: BlockDecoder
+    :members:
--- a/docs/reference/formats/index.rst
+++ b/docs/reference/formats/index.rst
@ -0,0 +1,7 @@
+Formats
+=======
+
+.. toctree::
+    :maxdepth: 2
+
+    s3tc.rst
--- a/docs/reference/formats/s3tc.rst
+++ b/docs/reference/formats/s3tc.rst
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@ -2,6 +2,7 @@ Reference
 =========

 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2

-   s3tc.rst
+    conversion.rst
+    formats/index.rst