Skip to content

Added README.md for generating sphinx docs #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yavorona merged 4 commits into from
May 6, 2020
Merged

Added README.md for generating sphinx docs #257

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67cc79d
Create README for sphinx docs
yavorona Apr 30, 2020
ec28553
Fix spelling
yavorona Apr 30, 2020
80801f4
Update README.md
yavorona May 1, 2020
7dc3dfa
Incorporate Ali's comments
yavorona May 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/README.md
View file
Open in desktop
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.