Skip to content

Commit 123f70c

Browse files
authored
Build docs using sphinx (census-instrumentation#53)
1 parent 3438dcc commit 123f70c

38 files changed

+16222
-0
lines changed

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.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = OPENCENSUS
8+
SOURCEDIR = docs
9+
BUILDDIR = docs/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/.nojekyll

Whitespace-only changes.

docs/_sources/index.rst.txt

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. OPENCENSUS documentation master file, created by
2+
sphinx-quickstart on Mon Oct 30 12:42:31 2017.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to OPENCENSUS's documentation!
7+
======================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:hidden:
12+
13+
trace/usage
14+
15+
Getting started
16+
---------------
17+
18+
The ``opencensus`` library is ``pip`` install-able:
19+
20+
.. code-block:: console
21+
22+
$ pip install opencensus
23+
24+
Fore more information on setting up your Python development environment, such as installing ``pip`` on your system, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
25+
26+
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup

0 commit comments

Comments
 (0)