Skip to content

Commit 9d18756

Browse files
yavoronaaliabbasrizvi
yavorona
and
aliabbasrizvi
authored
feat(doc): Using Sphinx to autogenerate documentation for the SDK (#262)
* 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]>
1 parent 61fddb0 commit 9d18756

17 files changed

+254
-25
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ datafile.json
2222

2323
# OSX folder metadata
2424
*.DS_Store
25+
26+
# Sphinx documentation
27+
docs/build/

‎CONTRIBUTING.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Contributing to the Optimizely Python SDK
2-
=========================================
1+
Contributing
2+
============
33

44
We welcome contributions and feedback! All contributors must sign our
55
[Contributor License Agreement
@@ -15,7 +15,7 @@ Development process
1515
2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)
1616
for each commit message.
1717
3. Make sure to add tests!
18-
4. Run `pep8` to ensure there are no lint errors.
18+
4. Run `flake8` to ensure there are no lint errors.
1919
5. `git push` your changes to GitHub.
2020
6. Open a PR from your fork into the master branch of the original
2121
repo.
@@ -34,13 +34,12 @@ Pull request acceptance criteria
3434
- Tests are located in `/tests` with one file per class.
3535
- Please don't change the `__version__`. We'll take care of bumping
3636
the version when we next release.
37-
- Lint your code with PEP-8 before submitting.
37+
- Lint your code with Flake8 before submitting.
3838

3939
Style
4040
-----
4141

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

4544
License
4645
-------

‎MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ include LICENSE
22
include CHANGELOG.md
33
include README.md
44
include requirements/*
5+
recursive-exclude docs *
56
recursive-exclude tests *

‎README.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
Optimizely Python SDK
22
=====================
33

4-
[![PyPI
5-
version](https://badge.fury.io/py/optimizely-sdk.svg)](https://pypi.org/project/optimizely-sdk)
6-
[![Build
7-
Status](https://travis-ci.org/optimizely/python-sdk.svg?branch=master)](https://travis-ci.org/optimizely/python-sdk)
8-
[![Coverage
9-
Status](https://coveralls.io/repos/github/optimizely/python-sdk/badge.svg)](https://coveralls.io/github/optimizely/python-sdk)
10-
[![Apache
11-
2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
4+
[![PyPI version](https://badge.fury.io/py/optimizely-sdk.svg)](https://pypi.org/project/optimizely-sdk)
5+
[![Build Status](https://travis-ci.org/optimizely/python-sdk.svg?branch=master)](https://travis-ci.org/optimizely/python-sdk)
6+
[![Coverage Status](https://coveralls.io/repos/github/optimizely/python-sdk/badge.svg)](https://coveralls.io/github/optimizely/python-sdk)
7+
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
128

139
This repository houses the official Python SDK for use with Optimizely
1410
Full Stack and Optimizely Rollouts.
@@ -126,21 +122,23 @@ notification_center.
126122
#### Advanced configuration
127123

128124
The following properties can be set to override the default
129-
configurations for [PollingConfigManager]{.title-ref}.
125+
configurations for [PollingConfigManager](#pollingconfigmanager).
130126

131-
**PropertyName** **Default Value** **Description**
132-
------------------ ----------------------------------------------------------- --------------------------------------------------------------------------------------
133-
update_interval 5 minutes Fixed delay between fetches for the datafile
134-
sdk_key None Optimizely project SDK key
135-
url None URL override location used to specify custom HTTP source for the Optimizely datafile
136-
url_template https://cdn.optimizely.com/datafiles/{sdk_key}.json Parameterized datafile URL by SDK key
137-
datafile None Initial datafile, typically sourced from a local cached source
127+
| **Property Name** |**Default Value**| **Description** |
128+
|:-----------------------:|:---------------:|:--------------------------------------------------------------:|
129+
| update_interval | 5 minutes | Fixed delay between fetches for the datafile |
130+
| sdk_key | None | Optimizely project SDK key |
131+
| url | None | URL override location used to specify custom |
132+
| HTTP source for Optimizely datafile<br>url_template |https://cdn.optimizely.com/datafiles/{sdk_key}.json|Parameterized datafile URL by SDK key|
133+
| datafile | None | Initial datafile, typically sourced from a local cached source |
138134

139135
A notification signal will be triggered whenever a *new* datafile is
140136
fetched and Project Config is updated. To subscribe to these
141137
notifications, use:
142138

143-
`notification_center.add_notification_listener(NotificationTypes.OPTIMIZELY_CONFIG_UPDATE, update_callback)`
139+
```
140+
notification_center.add_notification_listener(NotificationTypes.OPTIMIZELY_CONFIG_UPDATE, update_callback)
141+
```
144142

145143
For Further details see the Optimizely [Full Stack documentation](https://docs.developers.optimizely.com/full-stack/docs) to learn how to set up your first Python project and use the SDK.
146144

@@ -202,4 +200,4 @@ would be:
202200

203201
### Contributing
204202

205-
Please see [CONTRIBUTING](CONTRIBUTING.md).
203+
Please see [CONTRIBUTING](https://github.com/optimizely/python-sdk/blob/master/CONTRIBUTING.md).

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Documentation
2+
=============
3+
4+
Getting Started
5+
---------------
6+
7+
### Installing the requirements
8+
9+
To install dependencies required to generate sphinx documentation locally, execute the following command from the main directory:
10+
11+
pip install -r requirements/docs.txt
12+
13+
### Building documentation locally
14+
15+
To generate Python SDK documentation locally, execute the following commands:
16+
17+
cd docs/
18+
make html
19+
20+
This will build HTML docs in `docs/build/html/index.html`. Open this file in your web browser to see the docs.

‎docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/optimizely.png

3.17 KB
Loading

‎docs/source/api_reference.rst

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Optimizely's APIs
2+
=================
3+
.. automodule:: optimizely.optimizely
4+
:members:
5+
:special-members: __init__
6+
7+
8+
Event Dispatcher
9+
================
10+
.. autoclass:: optimizely.event_dispatcher.EventDispatcher
11+
:members:
12+
13+
14+
Logger
15+
======
16+
.. automodule:: optimizely.logger
17+
:members:
18+
19+
20+
User Profile
21+
============
22+
23+
``UserProfile``
24+
---------------
25+
26+
.. autoclass:: optimizely.user_profile.UserProfile
27+
:members:
28+
29+
``UserProfileService``
30+
----------------------
31+
32+
.. autoclass:: optimizely.user_profile.UserProfileService
33+
:members:

‎docs/source/conf.py

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('../..'))
16+
17+
from optimizely.version import __version__ # noqa: E402
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = 'Optimizely Python SDK'
22+
copyright = '2016-2020, Optimizely, Inc'
23+
author = 'Optimizely, Inc.'
24+
version = __version__
25+
master_doc = 'index'
26+
27+
# The full version, including alpha/beta/rc tags
28+
release = ''
29+
30+
# -- General configuration ---------------------------------------------------
31+
32+
# Add any Sphinx extension module names here, as strings. They can be
33+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34+
# ones.
35+
extensions = [
36+
"m2r",
37+
"sphinx.ext.autodoc",
38+
"sphinx.ext.napoleon",
39+
"sphinx.ext.autosectionlabel"
40+
]
41+
autosectionlabel_prefix_document = True
42+
43+
# Add any paths that contain templates here, relative to this directory.
44+
templates_path = ['_templates']
45+
46+
# List of patterns, relative to source directory, that match files and
47+
# directories to ignore when looking for source files.
48+
# This pattern also affects html_static_path and html_extra_path.
49+
exclude_patterns = [
50+
]
51+
52+
53+
# -- Options for HTML output -------------------------------------------------
54+
55+
# The theme to use for HTML and HTML Help pages. See the documentation for
56+
# a list of builtin themes.
57+
#
58+
# html_theme = 'alabaster'
59+
html_theme = "sphinx_rtd_theme"
60+
# Add any paths that contain custom static files (such as style sheets) here,
61+
# relative to this directory. They are copied after the builtin static files,
62+
# so a file named "default.css" will overwrite the builtin "default.css".
63+
# html_static_path = ['_static']
64+
html_logo = "../optimizely.png"

‎docs/source/config_manager.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Config Manager
2+
==============
3+
4+
``Base Config Manager``
5+
-----------------------
6+
7+
.. autoclass:: optimizely.config_manager.BaseConfigManager
8+
:members:
9+
10+
``Static Config Manager``
11+
-------------------------
12+
13+
.. autoclass:: optimizely.config_manager.StaticConfigManager
14+
:members:
15+
16+
``Polling Config Manager``
17+
--------------------------
18+
19+
.. autoclass:: optimizely.config_manager.PollingConfigManager
20+
:members:

‎docs/source/contributing.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../../CONTRIBUTING.md

‎docs/source/index.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Optimizely Python SDK
2+
=====================
3+
4+
.. toctree::
5+
:caption: Introduction
6+
7+
readme
8+
9+
10+
.. toctree::
11+
:caption: API reference
12+
13+
api_reference
14+
15+
16+
.. toctree::
17+
:caption: Configuration Data
18+
19+
config_manager
20+
optimizely_config
21+
22+
23+
.. toctree::
24+
:caption: Help
25+
26+
contributing

‎docs/source/optimizely_config.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
OptimizelyConfig
2+
================
3+
4+
.. automodule:: optimizely.optimizely_config
5+
:members:

‎docs/source/readme.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../../README.md

‎requirements/docs.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx==2.4.4
2+
sphinx-rtd-theme==0.4.3
3+
m2r==0.2.1

‎setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
'Programming Language :: Python :: 3.5',
5252
'Programming Language :: Python :: 3.6',
5353
],
54-
packages=find_packages(exclude=['tests']),
54+
packages=find_packages(exclude=['docs', 'tests']),
5555
extras_require={'test': TEST_REQUIREMENTS},
5656
install_requires=REQUIREMENTS,
5757
tests_require=TEST_REQUIREMENTS,

0 commit comments

Comments
 (0)