Skip to content

Commit

Permalink
Added README.md for generating sphinx docs (#257)
Browse files Browse the repository at this point in the history
* Create README for sphinx docs

* Fix spelling

* Update README.md

Add title

* Incorporate Ali's comments
  • Loading branch information
yavorona committed May 6, 2020
1 parent 242e08e commit 1b6c7f6
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Documentation
=============

Getting Started
---------------

### Installing the requirements

To install dependencies required to generate sphinx documentation locally, execute the following command from the main directory:

pip install -r requirements/docs.txt

### Building documentation locally

To generate Python SDK documentation locally, execute the following commands:

cd docs/
make html

This will build HTML docs in `docs/build/html/index.html`. Open this file in your web browser to see the docs.

0 comments on commit 1b6c7f6

Please sign in to comment.