feat: Add documentation generation support

Author: keelerm84

.readthedocs.yml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install --with docs
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

Makefile

@@ -1,3 +1,11 @@
+PYTEST_FLAGS=-W error::SyntaxWarning
+
+SPHINXOPTS    = -W --keep-going
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = launchdarkly-openfeature-server
+SOURCEDIR     = docs
+BUILDDIR      = $(SOURCEDIR)/build
+
 .PHONY: help
 help: #! Show this help message
 	@echo 'Usage: make [target] ... '
@@ -22,3 +30,13 @@ test: install
 lint: #! Run type analysis and linting checks
 lint: install
 	@poetry run mypy ld_openfeature tests
+
+#
+# Documentation generation
+#
+
+.PHONY: docs
+docs: #! Generate sphinx-based documentation
+	@poetry install --with docs
+	@cd docs
+	@poetry run $(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,29 @@
+# How the Python SDK documentation works
+
+The generated API documentation is built with [Sphinx](http://www.sphinx-doc.org/en/master/), and is hosted on [Read the Docs](https://readthedocs.org/).
+
+It uses the following:
+
+* Docstrings within the code. Docstrings can use any of the markup supported by Sphinx.
+* The `.rst` files in the `docs` directory. These provide the overall page structure.
+* The `conf.py` file containing Sphinx settings.
+
+## What to document
+
+Every public class, method, and module should have a docstring. Classes and methods with no docstring will not be included in the API docs.
+
+"Public" here means things that we want third-party developers to use. The SDK also contains many modules and classes that are not actually private (i.e. they aren't prefixed with `_`), but are for internal use only and aren't supported for any other use (we would like to reduce the amount of these in future).
+
+To add an undocumented class or method in an existing module to the docs, just give it a docstring.
+
+To add a new module to the docs, give it a docstring and then add a link to it in the appropriate `api-*.rst` file, in the same format as the existing links.
+
+## Undocumented things
+
+Modules that contain only implementation details are omitted from the docs by simply not including links to them in the `.rst` files.
+
+Internal classes in a documented module will be omitted from the docs if they do not have any docstrings, unless they inherit from another class that has docstrings. In the latter case, the way to omit them from the docs is to edit the `.rst` file that contains the link to that module, and add a `:members:` directive under the module that specifically lists all the classes that  _should_ be shown.
+
+## Testing
+
+In the `docs` directory, run `make html` to build all the docs. Then view `docs/build/html/index.html`.

docs/_static/.gitkeep

@@ -0,0 +1,8 @@
+Core API
+========
+
+ld_openfeature module
+---------------------
+
+.. automodule:: ld_openfeature
+    :members: LaunchDarklyProvider

docs/_templates/.gitkeep

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+# type: ignore
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+
+import ld_openfeature
+
+# -- Project information -----------------------------------------------------
+
+project = u'launchdarkly-openfeature-server'
+copyright = u'2024, LaunchDarkly'
+author = u'LaunchDarkly'
+
+# The short X.Y version.
+version = '0.1.0' # x-release-please-version
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0' # x-release-please-version
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['build']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'sphinx_rtd_theme'  # ReadTheDocs will set this
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'launchdarkly-openfeature-server-doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'launchdarkly-openfeature-server.tex', u'launchdarkly-openfeature-server Documentation',
+     u'LaunchDarkly', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'launchdarkly-openfeature-server', u'launchdarkly-openfeature-server Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'launchdarkly-openfeature-server', u'launchdarkly-openfeature-server Documentation',
+     author, 'launchdarkly-openfeature-server', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autodoc_default_options = {
+    'undoc-members': False
+}

docs/api-main.rst

@@ -0,0 +1,21 @@
+.. launchdarkly-openfeature-server documentation master file, created by
+   sphinx-quickstart on Mon Feb  4 13:16:49 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+LaunchDarkly OpenFeature provider for the Server-Side SDK for Python
+====================================================================
+
+This is the API reference for the `LaunchDarkly <https://launchdarkly.com/>`_ OpenFeature Provider for the Server-Side SDK for Python
+
+The latest version of the SDK can be found on `PyPI <https://pypi.org/project/launchdarkly-openfeature-server/>`_, and the source code is on `GitHub <https://github.com/launchdarkly/openfeature-python-server>`_.
+
+For more information, see LaunchDarkly's `Quickstart <https://docs.launchdarkly.com/home>`_ and `SDK Reference Guide <https://docs.launchdarkly.com/sdk/server-side/python>`_.
+
+Any types, functions, or constants that are not specifically described in this API reference should be considered implementation details that are not supported for external use; LaunchDarkly reserves the right to change them at any time and application code should not rely on them.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api-main

docs/conf.py

@@ -66,7 +66,7 @@ def __build_multi_context(self, context: EvaluationContext) -> Context:
                 continue
 
             key = attributes.get('key')
-            targeting_key = attributes.get('targeting_key')
+            targeting_key = attributes.get('targetingKey')
 
             if targeting_key is not None and not isinstance(targeting_key, str):
                 continue
@@ -83,8 +83,7 @@ def __build_single_context(self, attributes: Dict, kind: str, key: str) -> Conte
         builder.kind(kind)
 
         for k, v in attributes.items():
-            # TODO: In PHP this was camel case. Is that the case for python? Check the docs.
-            if k == 'key' or k == 'targeting_key':
+            if k == 'key' or k == 'targetingKey':
                 continue
 
             if k == 'name' and isinstance(v, str):

docs/index.rst

@@ -40,6 +40,21 @@ mypy = "==1.8.0"
 isort = "^5.13.2"
 
 
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^6.0.0"
+sphinx-rtd-theme = ">=1.3,<3.0"
+certifi = ">=2018.4.16"
+expiringdict = ">=1.1.4"
+pyrfc3339 = ">=1.0"
+jsonpickle = ">1.4.1"
+semver = ">=2.7.9"
+urllib3 = ">=1.22.0"
+jinja2 = "3.1.3"
+
+
 [tool.mypy]
 python_version = "3.8"
 install_types = true