actually add docs and remove rst from gitignore

yiwensong · Oct 17, 2018 · 6168da3 · 6168da3
1 parent 76c58c8
commit 6168da3
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,6 @@ example.py
 build/
 dist/
 *.egg-info/
-*.rst
 venv/
 *log.txt
 cbpro/__pycache__/
@@ -14,4 +13,4 @@ cbpro/__pycache__/
 tests/__pycache__/
 .pytest_cache
 .tox/
-docs/build
+docs/build/*
diff --git a/docs/source/authenticated_client.rst b/docs/source/authenticated_client.rst
@@ -0,0 +1,9 @@
+Authenticaed Client
+===================
+
+.. contents::
+
+Authenticaed Client
+-------------------
+.. automodule:: cbpro.authenticated_client
+    :members:
diff --git a/docs/source/cbpro_auth.rst b/docs/source/cbpro_auth.rst
@@ -0,0 +1,9 @@
+Authentication
+==============
+
+.. contents::
+
+Authentication
+--------------
+.. automodule:: cbpro.cbpro_auth
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,20 @@
+.. cbpro2 documentation master file, created by
+   sphinx-quickstart on Wed Oct 17 00:21:26 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+cbpro2
+======
+:mod:`cbpro2` is a python client library to interact with coinbase pro.
+
+Documentation
+-------------
+.. toctree::
+   :titlesonly:
+   :numbered: 1
+
+   public_client
+   authenticated_client
+   cbpro_auth
+   order_book
+   websocket_client
diff --git a/docs/source/order_book.rst b/docs/source/order_book.rst
@@ -0,0 +1,9 @@
+Order Book
+==========
+
+.. contents::
+
+Order Book
+----------
+.. automodule:: cbpro.order_book
+    :members:
diff --git a/docs/source/public_client.rst b/docs/source/public_client.rst
@@ -0,0 +1,9 @@
+Public Client
+=============
+
+.. contents::
+
+Public Client
+-------------
+.. automodule:: cbpro.public_client
+    :members:
diff --git a/docs/source/websocket_client.rst b/docs/source/websocket_client.rst
@@ -0,0 +1,9 @@
+Websocket Client
+=============
+
+.. contents::
+
+Websocket Client
+-------------
+.. automodule:: cbpro.websocket_client
+    :members: