Add Documentation (#125)

Add sphinx docs with readthedocs integration. Docs can be built locally with `poe docs`.
2020-09-20 21:00:02 +01:00
parent 58556e0eb6
commit d3e4fbb311
14 changed files with 973 additions and 98 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -0,0 +1,31 @@
+.. currentmodule:: betterproto
+
+API reference
+=============
+
+The following document outlines betterproto's api. **None** of these classes should be
+extended by the user manually.
+
+
+Message
+--------
+
+.. autoclass:: betterproto.Message
+    :members:
+    :special-members: __bytes__
+
+
+.. autofunction:: betterproto.serialized_on_wire
+
+.. autofunction:: betterproto.which_one_of
+
+
+Enumerations
+-------------
+
+.. autoclass:: betterproto.Enum()
+    :members:
+
+
+.. autoclass:: betterproto.Casing()
+    :members: