@@ -38,6 +38,7 @@ Python SteemEngine - A small library for querying and interacting with the Steem
38
38
Copyright (c) 2019 Privex Inc. ( https://www.privex.io )
39
39
```
40
40
41
+
41
42
# Quick Install / Usage
42
43
43
44
``` bash
@@ -77,6 +78,35 @@ a method's brackets (including the constructor brackets) to see the parameters y
77
78
Alternatively, just view the files inside of ` privex/steemengine/ ` - most methods and constructors
78
79
are adequately commented with PyDoc.
79
80
81
+ # Documentation
82
+
83
+ [ ![ Read the Documentation] ( https://read-the-docs-guidelines.readthedocs-hosted.com/_images/logo-wordmark-dark.png )] (
84
+ https://python-steemengine.readthedocs.io/en/latest/ )
85
+
86
+ Full documentation for this project is available above (click the Read The Docs image), including:
87
+
88
+ - How to install the application and it's dependencies
89
+ - How to use the various functions and classes
90
+ - General documentation of the modules and classes for contributors
91
+
92
+ ** To build the documentation:**
93
+
94
+ ``` bash
95
+ git clone https://github.com/Privex/python-steemengine
96
+ cd python-steemengine/docs
97
+ pip3 install -r requirements.txt
98
+
99
+ # It's recommended to run make clean to ensure old HTML files are removed
100
+ # `make html` generates the .html and static files in docs/build for production
101
+ make clean && make html
102
+
103
+ # After the files are built, you can live develop the docs using `make live`
104
+ # then browse to http://127.0.0.1:8100/
105
+ # If you have issues with content not showing up correctly, try make clean && make html
106
+ # then run make live again.
107
+ make live
108
+ ```
109
+
80
110
# Signing Transactions
81
111
82
112
For signing transactions, you will need a Beem wallet, with the password specified as the environmental variable
0 commit comments