Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinx docs #12

Merged
merged 27 commits into from
Jun 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
fe4e2d9
Add initial tracer API
c24t Jun 3, 2019
4456ea1
Fix context manager type hint
c24t Jun 4, 2019
49a9db1
Update opentelemetry/api/trace/__init__.py
c24t Jun 5, 2019
de3a2c3
Merge branch 'tracer-api-init' of github.com:c24t/opentelemetry-pytho…
c24t Jun 5, 2019
750a8d3
Add "Yields" to span docstring, remove "Raises"
c24t Jun 5, 2019
dd8fab2
Change get_context docstring
c24t Jun 5, 2019
e89b8ea
Sort imports
c24t Jun 5, 2019
eb32db0
Remove "global" from span context docstring
c24t Jun 5, 2019
3ca5e78
Split up span creation managers
c24t Jun 5, 2019
c3da103
Get declarative
c24t Jun 6, 2019
946f57d
Update tracer method names in docstring
c24t Jun 7, 2019
dd72455
Remove references to SDK from API comments
c24t Jun 19, 2019
02d8105
s/raise/pass/
c24t Jun 19, 2019
de53bbe
Add files generated by sphinx-quickstart
c24t Jun 4, 2019
cc889cc
Add files generated by sphinx-apidoc
c24t Jun 4, 2019
229ee1f
Add path to conf for autodoc
c24t Jun 4, 2019
8c1af06
Use RTD theme
c24t Jun 4, 2019
ad4fa03
Add extensions
c24t Jun 4, 2019
0f5b940
Touch makefile
c24t Jun 4, 2019
e67fff7
Add generated modules to index
c24t Jun 4, 2019
8bb8e2f
Add comments to extensions
c24t Jun 4, 2019
2e39c9f
Merge branch 'master' into sphinx-docs
c24t Jun 20, 2019
add9fb8
Move autodoc options to conf
c24t Jun 20, 2019
bb69069
Keep source member order in docs
c24t Jun 20, 2019
b725233
Merge branch 'master' into sphinx-docs
c24t Jun 21, 2019
ed97cf9
Update docs for package move
c24t Jun 21, 2019
8c0a19b
Remove missing static dir in conf
c24t Jun 21, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
68 changes: 68 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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 = []
26 changes: 26 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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`
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry
=============

.. toctree::
:maxdepth: 4

opentelemetry.trace
4 changes: 4 additions & 0 deletions docs/opentelemetry.trace.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
opentelemetry.trace package
===========================

.. automodule:: opentelemetry.trace