Skip to content
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

Jump to bottom

Sphinx docs #2

Merged
merged 3 commits into from
May 4, 2018
Merged

Sphinx docs #2

merged 3 commits into from
May 4, 2018

Conversation

gseva
Copy link
Contributor

@gseva gseva commented Apr 23, 2018

I'm moving the documentation to rst via sphinx, so we can host it on readthedocs. To generate the docs you must:

  • install docs requirements (Sphinx sphinx-rtd-theme)
  • cd docs && make html
  • open _build/html/index.html

ordonezf
ordonezf approved these changes Apr 24, 2018
View reviewed changes
Copy link
Contributor

@ordonezf ordonezf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@gseva gseva merged commit ed02e8d into master May 4, 2018
@gseva gseva deleted the sphinx-docs branch May 4, 2018 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ordonezf ordonezf ordonezf approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gseva @ordonezf