v1.0.6 - Fix list_transactions, plus docs improvements

Someguy123 · Someguy123 · commit f03efc2e24a0 · 2019-07-21T14:25:09.000+01:00
- Fixed/added Pydoc comments for most methods, allowing the docs to render correctly
 - Added usage examples for every method in SteemEngineToken
 - Added/changed return / parameter types to more methods for better IDE assistance
 - Added the `steem` property to the docs
 - Fixed exceptions docs so they show up correctly in the sidebar
 - Other small mostly documentational changes
diff --git a/docs/source/code/SENGToken/privex.steemengine.SteemEngineToken.__init__.rst b/docs/source/code/SENGToken/privex.steemengine.SteemEngineToken.__init__.rst
diff --git a/docs/source/code/index.rst b/docs/source/code/index.rst
@@ -3,4 +3,5 @@
 
     privex.steemengine.SteemEngineToken.SteemEngineToken
     privex.steemengine.SteemEngineHistory.SteemEngineHistory
+    privex.steemengine.exceptions
     tests
diff --git a/docs/source/code/privex.steemengine.SteemEngineToken.SteemEngineToken.rst b/docs/source/code/privex.steemengine.SteemEngineToken.SteemEngineToken.rst
@@ -33,7 +33,9 @@ SteemEngineToken
    .. rubric:: Attributes
 
    .. autosummary::
+      :toctree: stubs
    
       ~SteemEngineToken.steem
+      ~SteemEngineToken._steem
    
    
diff --git a/docs/source/code/privex.steemengine.exceptions.rst b/docs/source/code/privex.steemengine.exceptions.rst
@@ -1,4 +1,4 @@
-privex.steemengine.exceptions
+Exceptions
 =============================
 
 .. automodule:: privex.steemengine.exceptions
diff --git a/docs/source/code/stubs/privex.steemengine.SteemEngineToken.SteemEngineToken._steem.rst b/docs/source/code/stubs/privex.steemengine.SteemEngineToken.SteemEngineToken._steem.rst
@@ -0,0 +1,6 @@
+SteemEngineToken.\_steem
+============================================================
+
+.. currentmodule:: privex.steemengine.SteemEngineToken
+
+.. autoattribute:: SteemEngineToken._steem
diff --git a/docs/source/code/stubs/privex.steemengine.SteemEngineToken.SteemEngineToken.steem.rst b/docs/source/code/stubs/privex.steemengine.SteemEngineToken.SteemEngineToken.steem.rst
@@ -0,0 +1,6 @@
+SteemEngineToken.steem
+==========================================================
+
+.. currentmodule:: privex.steemengine.SteemEngineToken
+
+.. autoproperty:: SteemEngineToken.steem
diff --git a/docs/source/code/stubs/privex.steemengine.exceptions.AccountNotFound.rst b/docs/source/code/stubs/privex.steemengine.exceptions.AccountNotFound.rst
@@ -1,4 +1,4 @@
-privex.steemengine.exceptions.AccountNotFound
+exceptions.AccountNotFound
 =============================================
 
 .. currentmodule:: privex.steemengine.exceptions
diff --git a/docs/source/code/stubs/privex.steemengine.exceptions.NotEnoughBalance.rst b/docs/source/code/stubs/privex.steemengine.exceptions.NotEnoughBalance.rst
@@ -1,4 +1,4 @@
-privex.steemengine.exceptions.NotEnoughBalance
+exceptions.NotEnoughBalance
 ==============================================
 
 .. currentmodule:: privex.steemengine.exceptions
diff --git a/docs/source/code/stubs/privex.steemengine.exceptions.TokenNotFound.rst b/docs/source/code/stubs/privex.steemengine.exceptions.TokenNotFound.rst
@@ -1,4 +1,4 @@
-privex.steemengine.exceptions.TokenNotFound
+exceptions.TokenNotFound
 ===========================================
 
 .. currentmodule:: privex.steemengine.exceptions
diff --git a/privex/steemengine/SteemEngineToken.py b/privex/steemengine/SteemEngineToken.py
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-privex.steemengine.exceptions`
	`1`	`+Exceptions`
`2`	`2`	`=============================`
`3`	`3`
`4`	`4`	`.. automodule:: privex.steemengine.exceptions`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-privex.steemengine.exceptions.AccountNotFound`
	`1`	`+exceptions.AccountNotFound`
`2`	`2`	`=============================================`
`3`	`3`
`4`	`4`	`.. currentmodule:: privex.steemengine.exceptions`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-privex.steemengine.exceptions.NotEnoughBalance`
	`1`	`+exceptions.NotEnoughBalance`
`2`	`2`	`==============================================`
`3`	`3`
`4`	`4`	`.. currentmodule:: privex.steemengine.exceptions`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-privex.steemengine.exceptions.TokenNotFound`
	`1`	`+exceptions.TokenNotFound`
`2`	`2`	`===========================================`
`3`	`3`
`4`	`4`	`.. currentmodule:: privex.steemengine.exceptions`