-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Botisimo Documentation | ||
|
||
This documentation is built using [Sphinx docs](https://www.sphinx-doc.org/), which uses [reST](http://docutils.sourceforge.net/rst.html) for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file. | ||
|
||
Sphinx docs is pip-installable via `pip install sphinx`. Once installed, open a command line in the docs folder and run the following commands: | ||
|
||
```bash | ||
$ sudo pip install -r requirements.txt | ||
``` | ||
|
||
This will install the requirements needed for the generating the docs. Afterwards you can run: | ||
|
||
```bash | ||
$ make html | ||
``` | ||
|
||
The docs will be generated, the output files will be placed in the `_build/html/` directory, and can be browsed (locally) with any browser. | ||
|
||
The docs can also be found online at [https://docs.botisimo.com](https://docs.botisimo.com). |