diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b8aee81..d14002e1 100644 --- a/CONTRIBUTING.md +++ b/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 ------- diff --git a/README.md b/README.md index 6192c567..48f29ca9 100644 --- a/README.md +++ b/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). diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 6f3a60bf..b6f12115 100644 --- a/docs/source/api_reference.rst +++ b/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 diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 2325522f..e793cd01 100644 --- a/docs/source/bucketing_algorithm.rst +++ b/docs/source/bucketing_algorithm.rst @@ -1,5 +1,5 @@ -Bucketing Algorithm Methods -=========================== +Bucketing +========= .. automodule:: optimizely.bucketer :members: diff --git a/docs/source/conf.py b/docs/source/conf.py index 89097abf..08da5631 100644 --- a/docs/source/conf.py +++ b/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__ diff --git a/docs/source/index.rst b/docs/source/index.rst index ba046b65..67a46059 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,10 @@ -Python SDK -========== +Optimizely Python SDK +===================== -.. mdinclude:: ../../README.md +.. toctree:: + :caption: Introduction + + readme .. toctree:: diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 00000000..57de8658 --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../README.md \ No newline at end of file