Skip to content

Commit

Permalink
Build docs using sphinx (#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
liyanhui1228 authored Nov 2, 2017
1 parent 3438dcc commit 123f70c
Show file tree
Hide file tree
Showing 38 changed files with 16,222 additions and 0 deletions.
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = OPENCENSUS
SOURCEDIR = docs
BUILDDIR = docs/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)
Empty file added docs/.nojekyll
Empty file.
26 changes: 26 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. OPENCENSUS documentation master file, created by
sphinx-quickstart on Mon Oct 30 12:42:31 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OPENCENSUS's documentation!
======================================

.. toctree::
:maxdepth: 2
:hidden:

trace/usage

Getting started
---------------

The ``opencensus`` library is ``pip`` install-able:

.. code-block:: console
$ pip install opencensus
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.

.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
Loading

0 comments on commit 123f70c

Please sign in to comment.