500b57e935
* Adds `docs` directory, along with boilerplate code and templates for readthedocs.org. * docs: update orders spec Co-authored-by: Lawrence Forman <me@merklejerk.com>
19 lines
457 B
Markdown
19 lines
457 B
Markdown
### Dependencies
|
|
```bash
|
|
pip3 install sphinx recommonmark
|
|
```
|
|
|
|
### Syntax
|
|
Documentation can be written in [Markdown](https://en.wikipedia.org/wiki/Markdown) (.md) or [Restructured Text](https://en.wikipedia.org/wiki/ReStructuredText) (.rst).
|
|
|
|
### Build and Test
|
|
```bash
|
|
cd docs
|
|
make html
|
|
open _build/html/index.html
|
|
```
|
|
|
|
### Tips
|
|
* Generate RST tables [here](https://www.tablesgenerator.com/text_tables#).
|
|
* Set your editor's ruler to `100` characters.
|