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.

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

Update documentation #162

Merged
merged 3 commits into from Jul 17, 2018
Merged

Update documentation #162

merged 3 commits into from Jul 17, 2018

Conversation

yangchoo
Copy link
Contributor

This change fixes existing documentation and updates the current documentation so that we are able to execute sphinx build with no warnings.

yangchoo added 3 commits July 11, 2018 02:49
Summary:
Updated docs to use more of autodoc, and fixed existing documentation issues.

Also added `Instruction` section to help with autolinking

Also added __version__ in version.py to help with managing version in only one place

Test Plan: sphinx-build produces no warnings except for container-type.rst, which needs to be fixed

Reviewers: rhys, varun

Differential Revision: https://work.r23s.net/D10952
@yangchoo yangchoo requested a review from rhysormond July 14, 2018 20:59
Copy link
Member

@rhysormond rhysormond left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

@yangchoo yangchoo merged commit f5c5ca9 into master Jul 17, 2018
@yangchoo yangchoo deleted the docs-update branch July 17, 2018 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants