Added README.md for generating sphinx docs #257
Merged
Conversation
This file contains hidden or 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
Add title
optimizely-codereview-bot
added
🤖 4 hrs
🤖 8 hrs
🤖 12 hrs
🤖 16 hrs
and removed
🤖 4 hrs
🤖 8 hrs
🤖 12 hrs
labels
aliabbasrizvi
suggested changes
May 5, 2020
docs/README.md
Outdated
| @@ -0,0 +1,22 @@ | |||
| Optimizely Python SDK Sphinx Documentation | |||
| ===================== | |||
There was a problem hiding this comment.
This should be until under Documentation
docs/README.md
Outdated
| @@ -0,0 +1,22 @@ | |||
| Optimizely Python SDK Sphinx Documentation | |||
There was a problem hiding this comment.
Suggested change
| Optimizely Python SDK Sphinx Documentation | |
| Documentation |
docs/README.md
Outdated
| Getting Started | ||
| --------------- | ||
|
|
||
| ### Installing documentation requirements |
There was a problem hiding this comment.
Suggested change
| ### Installing documentation requirements | |
| ### Installing the requirements |
docs/README.md
Outdated
|
|
||
| ### Building documentation locally | ||
|
|
||
| To generate python SDK documentation locally, execute the following command: |
There was a problem hiding this comment.
Suggested change
| To generate python SDK documentation locally, execute the following command: | |
| To generate Python SDK documentation locally, execute the following commands: |
docs/README.md
Outdated
|
|
||
| This will build HTML docs in `docs/build` directory. To open documentation, simply run: | ||
|
|
||
| open build/html/index.html |
There was a problem hiding this comment.
This is a very OS specific command. You can probably remove this and just mention to get documentation under build/html
yavorona
changed the title
yavorona
added a commit
that referenced
this pull request
May 12, 2020
* Create README for sphinx docs * Fix spelling * Update README.md Add title * Incorporate Ali's comments
yavorona
added a commit
that referenced
this pull request
May 14, 2020
* Create README for sphinx docs * Fix spelling * Update README.md Add title * Incorporate Ali's comments
yavorona
added a commit
that referenced
this pull request
May 14, 2020
* Add docs.txt to requirements (#242) Co-authored-by: Polina Nguen <[email protected]> * Create script to generate html docs with sphinx (#243) * 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]> * Include docstrings from bucketer.py and decision_service.py to the docs (#244) * Include docstrings from bucketer.py and decision_service.py to the docs * Fix Travis failure Co-authored-by: Polina Nguen <[email protected]> * Add docstrings from config_manager.py and optimizely_config.py to docs (#245) Update buckering_algorithm to exclude namedtuble docstrings Co-authored-by: Polina Nguen <[email protected]> * Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings 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 logger.py and user_profile.py docstrings to the docs. (#247) * 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]> * Adding version of python sdk to docs (#249) * 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]> * Remove private methods (#250) * Update sphinx docs per OASIS-6317 (#252) * 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 * Add Optimizely logo to docs (#256) * [OASIS-6317] - Fix README.md format (#255) * Fix table in Advanced configuration * Fix anchor * Added README.md for generating sphinx docs (#257) * Create README for sphinx docs * Fix spelling * Update README.md Add title * Incorporate Ali's comments * chore(build): Making sure docs is excluded from build (#258) * Removed Bucketing Algorithm Section and Added Description of Class Init Options in class Optimizely (#259) * Remove bucketing algorithm section * Add __init__ to class optimizely.optimizely.Optimizely * Specified master_doc Co-authored-by: Ali Abbas Rizvi <[email protected]>
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
Added README.md for generating sphinx docs
Test plan
None
Issues