Skip to content

Update sphinx docs per OASIS-6317 #252

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

Merged
merged 7 commits into from
Apr 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Development process
2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)
for each commit message.
3. Make sure to add tests!
4. Run `pep8` to ensure there are no lint errors.
4. Run `flake8` to ensure there are no lint errors.
5. `git push` your changes to GitHub.
6. Open a PR from your fork into the master branch of the original
repo.
Expand All @@ -34,13 +34,12 @@ Pull request acceptance criteria
- Tests are located in `/tests` with one file per class.
- Please don't change the `__version__`. We'll take care of bumping
the version when we next release.
- Lint your code with PEP-8 before submitting.
- Lint your code with Flake8 before submitting.

Style
-----

We enforce Flake8 rules with a few minor
[deviations](https://github.com/optimizely/python-sdk/blob/master/tox.ini).
We enforce Flake8 rules.

License
-------
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,4 +200,4 @@ would be:

### Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md).
Please see [CONTRIBUTING](https://github.com/optimizely/python-sdk/blob/master/CONTRIBUTING.md).
16 changes: 0 additions & 16 deletions docs/source/api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,6 @@ Optimizely's APIs
:members:


Event Builder
=============

``Event``
---------

.. autoclass:: optimizely.event_builder.Event
:members:

``EventBuilder``
----------------

.. autoclass:: optimizely.event_builder.EventBuilder
:members:


Event Dispatcher
================
.. autoclass:: optimizely.event_dispatcher.EventDispatcher
Expand Down
4 changes: 2 additions & 2 deletions docs/source/bucketing_algorithm.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Bucketing Algorithm Methods
===========================
Bucketing
=========
.. automodule:: optimizely.bucketer
:members:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# -- Project information -----------------------------------------------------

project = 'Python SDK'
project = 'Optimizely Python SDK'
copyright = '2016-2020, Optimizely, Inc'
author = 'Optimizely, Inc.'
version = __version__
Expand Down
9 changes: 6 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Python SDK
==========
Optimizely Python SDK
=====================

.. mdinclude:: ../../README.md
.. toctree::
:caption: Introduction

readme
Copy link
Contributor

Choose a reason for hiding this comment

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

There is no readme.rst yet right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is, sorry! I just pushed it to the pr.



.. toctree::
Expand Down
1 change: 1 addition & 0 deletions docs/source/readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../../README.md