summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Treinish <mtreinish@kortar.org>2016-08-31 16:26:04 -0400
committerMatthew Treinish <mtreinish@kortar.org>2016-08-31 16:26:04 -0400
commit304fb10389494585aac617c5b076f67d66203011 (patch)
tree1d78929c5fb8fe04d1652daff4d77892f86deb9e
parent8ebe7acd063c68a8494a01b2005c927b9aa70ffb (diff)
Add doc building infra
-rwxr-xr-xdoc/source/conf.py74
-rw-r--r--doc/source/index.rst9
-rw-r--r--doc/source/readme.rst1
3 files changed, 84 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100755
index 0000000..4b9c9ca
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,74 @@
1# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import os
16import sys
17
18sys.path.insert(0, os.path.abspath('../..'))
19# -- General configuration ----------------------------------------------------
20
21# Add any Sphinx extension module names here, as strings. They can be
22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23extensions = [
24 'sphinx.ext.autodoc',
25 'oslosphinx',
26]
27
28# autodoc generation is a bit aggressive and a nuisance when doing heavy
29# text edit cycles.
30# execute "export SPHINX_DEBUG=1" in your terminal to disable
31
32# The suffix of source filenames.
33source_suffix = '.rst'
34
35# The master toctree document.
36master_doc = 'index'
37
38# General information about the project.
39project = u'lpmqtt'
40copyright = u'2016, Matthew Treinish'
41
42# If true, '()' will be appended to :func: etc. cross-reference text.
43add_function_parentheses = True
44
45# If true, the current module name will be prepended to all description
46# unit titles (such as .. function::).
47add_module_names = True
48
49# The name of the Pygments (syntax highlighting) style to use.
50pygments_style = 'sphinx'
51
52# -- Options for HTML output --------------------------------------------------
53
54# The theme to use for HTML and HTML Help pages. Major themes that come with
55# Sphinx are currently 'default' and 'sphinxdoc'.
56# html_theme_path = ["."]
57# html_theme = '_theme'
58# html_static_path = ['static']
59
60# Output file base name for HTML help builder.
61htmlhelp_basename = '%sdoc' % project
62
63# Grouping the document tree into LaTeX files. List of tuples
64# (source start file, target name, title, author, documentclass
65# [howto/manual]).
66latex_documents = [
67 ('index',
68 '%s.tex' % project,
69 u'%s Documentation' % project,
70 u'Matthew Treinish', 'manual'),
71]
72
73# Example configuration for intersphinx: refer to the Python standard library.
74# intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..0d49eac
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,9 @@
1lpmqtt
2======
3
4Contents:
5
6.. toctree::
7 :maxdepth: 2
8
9 readme
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
new file mode 100644
index 0000000..a6210d3
--- /dev/null
+++ b/doc/source/readme.rst
@@ -0,0 +1 @@
.. include:: ../../README.rst