Account placeholder docs

alexgolec · Apr 3, 2024 · 92e6567 · 92e6567
1 parent 5e3ea54
commit 92e6567
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/docs/client.rst b/docs/client.rst
@@ -0,0 +1,28 @@
+.. highlight:: python
+.. py:module:: schwab.client
+
+.. _client:
+
+===========
+HTTP Client
+===========
+
+++++++++++++
+Account Info
+++++++++++++
+
+These methods provide access to useful information about accounts. An incomplete 
+list of the most interesting bits:
+
+* Account balances, including available trading balance
+* Positions
+* Order history
+
+See the official documentation for each method for a complete response schema.
+
+.. automethod:: schwab.client.Client.get_account_numbers
+.. automethod:: schwab.client.Client.get_account
+.. automethod:: schwab.client.Client.get_accounts
+.. autoclass:: schwab.client.Client.Account
+  :members:
+  :undoc-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,7 +14,15 @@
    :target: https://discord.gg/M3vjtHj
 
 
-This package is very much under construction. Please come back later.
+This package is very much under construction. Please don't use it unless you 
+know exactly what you're doing.
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  client
+
 
 
 **Disclaimer:** *schwab-py is an unofficial API wrapper. It is in no way 

diff --git a/schwab/client/base.py b/schwab/client/base.py
@@ -160,8 +160,8 @@ def get_account(self, account_id, *, fields=None):
         return self._get_request(path, params)
 
     def get_account_numbers(self):
-        # TODO: Documentation
         '''
+        TODO
         '''
         path = '/trader/v1/accounts/accountNumbers'
         return self._get_request(path, {})