diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000000..51285967a7d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000000..414c33d3df6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,68 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains 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('../opentelemetry-api/')) + + +# -- Project information ----------------------------------------------------- + +project = 'OpenTelemetry' +copyright = '2019, OpenTelemetry Authors' +author = 'OpenTelemetry Authors' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + # API doc generation + 'sphinx.ext.autodoc', + # Support for google-style docstrings + 'sphinx.ext.napoleon', + # Infer types from hints instead of docstrings + 'sphinx_autodoc_typehints', + # Add links to source from generated docs + 'sphinx.ext.viewcode', + # Link to other sphinx docs + 'sphinx.ext.intersphinx', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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', 'Thumbs.db', '.DS_Store'] + +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'show-inheritance': True, + 'member-order': 'bysource' +} + +# -- 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' + +# 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 = [] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000000..aed678db966 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,26 @@ +.. OpenTelemetry documentation master file, created by + sphinx-quickstart on Mon Jun 3 22:48:38 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +OpenTelemetry API +================= + +Welcome to OpenTelemetry's API documentation! + +This documentation describes the ``opentelemetry-api`` package, which provides +abstract types for OpenTelemetry implementations. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + opentelemetry.trace + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000000..27f573b87af --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 00000000000..b795cd4515a --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +opentelemetry +============= + +.. toctree:: + :maxdepth: 4 + + opentelemetry.trace diff --git a/docs/opentelemetry.trace.rst b/docs/opentelemetry.trace.rst new file mode 100644 index 00000000000..cec44bd8178 --- /dev/null +++ b/docs/opentelemetry.trace.rst @@ -0,0 +1,4 @@ +opentelemetry.trace package +=========================== + +.. automodule:: opentelemetry.trace