feat(doc): Using Sphinx to autogenerate documentation for the SDK #262
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Polina Nguen <[email protected]>
* Create script to generate html docs with sphinx Add minor changes to README.md and CONTRIBUTING.md for proper conversion to .rst * Address comments * Clean up Co-authored-by: Polina Nguen <[email protected]>
…cs (#244) * Include docstrings from bucketer.py and decision_service.py to the docs * Fix Travis failure Co-authored-by: Polina Nguen <[email protected]>
#245) Update buckering_algorithm to exclude namedtuble docstrings Co-authored-by: Polina Nguen <[email protected]>
…ings to the docs (#246) * Added optimizely.py to docs * Returned to having private methods included for now. * Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs Co-authored-by: Polina Nguen <[email protected]>
* Added optimizely.py to docs * Returned to having private methods included for now. * Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs * Added user_profile.py and logger.py docstrings to docs Moved all api_reference components into one rst file Co-authored-by: Polina Nguen <[email protected]>
* Added optimizely.py to docs * Returned to having private methods included for now. * Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs * Add version to docs * Update branch Co-authored-by: Polina Nguen <[email protected]>
* Change pip8 to flake8 * Update contributing link to work in sphinx docs * Remove Event Builder * Change “Bucketing Algorithm Methods” to “Bucketing” * Update project name * Include README to table of contents * Create readme.rst for readme.md
* Fix table in Advanced configuration * Fix anchor
* Create README for sphinx docs * Fix spelling * Update README.md Add title * Incorporate Ali's comments
…it Options in class Optimizely (#259) * Remove bucketing algorithm section * Add __init__ to class optimizely.optimizely.Optimizely
aliabbasrizvi
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Introducing autogenerated documentation using Sphinx