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

Author: yavorona

CONTRIBUTING.md

@@ -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.
@@ -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
 -------

README.md

@@ -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).

docs/source/api_reference.rst

@@ -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

docs/source/bucketing_algorithm.rst

@@ -1,5 +1,5 @@
-Bucketing Algorithm Methods
-===========================
+Bucketing
+=========
 .. automodule:: optimizely.bucketer
    :members:
 

docs/source/conf.py

@@ -18,7 +18,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Python SDK'
+project = 'Optimizely Python SDK'
 copyright = '2016-2020, Optimizely, Inc'
 author = 'Optimizely, Inc.'
 version = __version__

docs/source/index.rst

@@ -1,7 +1,10 @@
-Python SDK
-==========
+Optimizely Python SDK
+=====================
 
-.. mdinclude:: ../../README.md
+.. toctree::
+   :caption: Introduction
+
+   readme
 
 
 .. toctree::

docs/source/readme.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../README.md