Skip to content

Commit e7b5279

Browse files
c24tc24t
authored
Add sphinx docs (#12)
1 parent 41f0caa commit e7b5279

File tree

6 files changed

+159
-0
lines changed

6 files changed

+159
-0
lines changed

‎docs/Makefile

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

‎docs/conf.py

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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+
# http://www.sphinx-doc.org/en/master/config
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('../opentelemetry-api/'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'OpenTelemetry'
21+
copyright = '2019, OpenTelemetry Authors'
22+
author = 'OpenTelemetry Authors'
23+
24+
25+
# -- General configuration ---------------------------------------------------
26+
27+
# Add any Sphinx extension module names here, as strings. They can be
28+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29+
# ones.
30+
extensions = [
31+
# API doc generation
32+
'sphinx.ext.autodoc',
33+
# Support for google-style docstrings
34+
'sphinx.ext.napoleon',
35+
# Infer types from hints instead of docstrings
36+
'sphinx_autodoc_typehints',
37+
# Add links to source from generated docs
38+
'sphinx.ext.viewcode',
39+
# Link to other sphinx docs
40+
'sphinx.ext.intersphinx',
41+
]
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 = ['_build', 'Thumbs.db', '.DS_Store']
50+
51+
autodoc_default_options = {
52+
'members': True,
53+
'undoc-members': True,
54+
'show-inheritance': True,
55+
'member-order': 'bysource'
56+
}
57+
58+
# -- Options for HTML output -------------------------------------------------
59+
60+
# The theme to use for HTML and HTML Help pages. See the documentation for
61+
# a list of builtin themes.
62+
#
63+
html_theme = 'sphinx_rtd_theme'
64+
65+
# Add any paths that contain custom static files (such as style sheets) here,
66+
# relative to this directory. They are copied after the builtin static files,
67+
# so a file named "default.css" will overwrite the builtin "default.css".
68+
html_static_path = []

‎docs/index.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. OpenTelemetry documentation master file, created by
2+
sphinx-quickstart on Mon Jun 3 22:48:38 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
OpenTelemetry API
7+
=================
8+
9+
Welcome to OpenTelemetry's API documentation!
10+
11+
This documentation describes the ``opentelemetry-api`` package, which provides
12+
abstract types for OpenTelemetry implementations.
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
:caption: Contents:
17+
18+
opentelemetry.trace
19+
20+
21+
Indices and tables
22+
==================
23+
24+
* :ref:`genindex`
25+
* :ref:`modindex`
26+
* :ref:`search`

‎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=.
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%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

‎docs/modules.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentelemetry
2+
=============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
opentelemetry.trace

‎docs/opentelemetry.trace.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
opentelemetry.trace package
2+
===========================
3+
4+
.. automodule:: opentelemetry.trace

0 commit comments

Comments
 (0)