Skip to content

Commit f6a4419

Browse files
committed
Added README.md for generating sphinx docs (#257)
* Create README for sphinx docs * Fix spelling * Update README.md Add title * Incorporate Ali's comments
1 parent 76a6c0b commit f6a4419

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Documentation
2+
=============
3+
4+
Getting Started
5+
---------------
6+
7+
### Installing the requirements
8+
9+
To install dependencies required to generate sphinx documentation locally, execute the following command from the main directory:
10+
11+
pip install -r requirements/docs.txt
12+
13+
### Building documentation locally
14+
15+
To generate Python SDK documentation locally, execute the following commands:
16+
17+
cd docs/
18+
make html
19+
20+
This will build HTML docs in `docs/build/html/index.html`. Open this file in your web browser to see the docs.

0 commit comments

Comments
 (0)