-
Notifications
You must be signed in to change notification settings - Fork 4
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
1 parent
537218a
commit 43d4d9c
Showing
1 changed file
with
16 additions
and
1 deletion.
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 |
---|---|---|
@@ -1 +1,16 @@ | ||
## How to build the documentation | ||
This folder contains the Modelhub documentation files. We are using Sphinx to build our documentation and include code documentation. The Modelhub documentation is hosted at [modelhub.readthedocs.io](http://modelhub.readthedocs.io). _Read the Docs_ builds the documentation automatically. Nevertheless, if you want to build the docs locally, read on. | ||
|
||
### How to build the docs locally | ||
|
||
#### Prerequisites | ||
``` | ||
pip install Sphinx | ||
pip install | ||
``` | ||
|
||
#### Build | ||
Open a terminal and navigate to this folder (_modelhub-engine/docs_) in your local clone of this repository. Then execute: | ||
``` | ||
make html | ||
``` | ||
The documentation will be generated into the subfolder _build_ |