GitList
Browse code

add barebones documentation pages

Joseph Weston authored on 20/08/2018 17:11:01 • Bas Nijholt committed on 16/10/2018 18:12:39
Showing 4 changed files
docs/.gitignore
History View file @ 77a12a1
1 1 
new file mode 100644
... ... 
@@ -0,0 +1 @@
1 
+build/*
docs/Makefile
History View file @ 77a12a1
0 2 
new file mode 100644
... ... 
@@ -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    = adaptive
8 
+SOURCEDIR     = source
9 
+BUILDDIR      = 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)
0 21 
\ No newline at end of file
docs/source/conf.py
History View file @ 77a12a1
1 22 
new file mode 100644
... ... 
@@ -0,0 +1,112 @@
1 
+# -*- coding: utf-8 -*-
2 
+#
3 
+# Configuration file for the Sphinx documentation builder.
4 
+#
5 
+# This file does only contain a selection of the most common options. For a
6 
+# full list see the documentation:
7 
+# http://www.sphinx-doc.org/en/master/config
8 
+
9 
+# -- Path setup --------------------------------------------------------------
10 
+
11 
+# If extensions (or modules to document with autodoc) are in another directory,
12 
+# add these directories to sys.path here. If the directory is relative to the
13 
+# documentation root, use os.path.abspath to make it absolute, like shown here.
14 
+#
15 
+import os
16 
+import sys
17 
+sys.path.insert(0, os.path.abspath('../..'))
18 
+
19 
+import adaptive
20 
+
21 
+
22 
+# -- Project information -----------------------------------------------------
23 
+
24 
+project = 'adaptive'
25 
+copyright = '2018, Adaptive Authors'
26 
+author = 'Adaptive Authors'
27 
+
28 
+# The short X.Y version
29 
+version = adaptive.__version__
30 
+# The full version, including alpha/beta/rc tags
31 
+release = adaptive.__version__
32 
+
33 
+
34 
+# -- General configuration ---------------------------------------------------
35 
+
36 
+# If your documentation needs a minimal Sphinx version, state it here.
37 
+#
38 
+# needs_sphinx = '1.0'
39 
+
40 
+# Add any Sphinx extension module names here, as strings. They can be
41 
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42 
+# ones.
43 
+extensions = [
44 
+    'sphinx.ext.autodoc',
45 
+    'sphinx.ext.mathjax',
46 
+    'sphinx.ext.viewcode',
47 
+    'sphinx.ext.napoleon',
48 
+]
49 
+
50 
+# Add any paths that contain templates here, relative to this directory.
51 
+templates_path = ['_templates']
52 
+
53 
+# The suffix(es) of source filenames.
54 
+# You can specify multiple suffix as a list of string:
55 
+#
56 
+# source_suffix = ['.rst', '.md']
57 
+source_suffix = '.rst'
58 
+
59 
+# The master toctree document.
60 
+master_doc = 'index'
61 
+
62 
+# The language for content autogenerated by Sphinx. Refer to documentation
63 
+# for a list of supported languages.
64 
+#
65 
+# This is also used if you do content translation via gettext catalogs.
66 
+# Usually you set "language" from the command line for these cases.
67 
+language = None
68 
+
69 
+# List of patterns, relative to source directory, that match files and
70 
+# directories to ignore when looking for source files.
71 
+# This pattern also affects html_static_path and html_extra_path .
72 
+exclude_patterns = []
73 
+
74 
+# The name of the Pygments (syntax highlighting) style to use.
75 
+pygments_style = 'sphinx'
76 
+
77 
+
78 
+# -- Options for HTML output -------------------------------------------------
79 
+
80 
+# The theme to use for HTML and HTML Help pages.  See the documentation for
81 
+# a list of builtin themes.
82 
+#
83 
+html_theme = 'sphinx_rtd_theme'
84 
+
85 
+# Theme options are theme-specific and customize the look and feel of a theme
86 
+# further.  For a list of options available for each theme, see the
87 
+# documentation.
88 
+#
89 
+# html_theme_options = {}
90 
+
91 
+# Add any paths that contain custom static files (such as style sheets) here,
92 
+# relative to this directory. They are copied after the builtin static files,
93 
+# so a file named "default.css" will overwrite the builtin "default.css".
94 
+html_static_path = ['_static']
95 
+
96 
+# Custom sidebar templates, must be a dictionary that maps document names
97 
+# to template names.
98 
+#
99 
+# The default sidebars (for documents that don't match any pattern) are
100 
+# defined by theme itself.  Builtin themes are using these templates by
101 
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
102 
+# 'searchbox.html']``.
103 
+#
104 
+# html_sidebars = {}
105 
+
106 
+
107 
+# -- Options for HTMLHelp output ---------------------------------------------
108 
+
109 
+# Output file base name for HTML help builder.
110 
+htmlhelp_basename = 'adaptivedoc'
111 
+
112 
+# -- Extension configuration -------------------------------------------------
docs/source/index.rst
History View file @ 77a12a1
0 113 
new file mode 100644
... ... 
@@ -0,0 +1,20 @@
1 
+.. adaptive documentation master file, created by
2 
+   sphinx-quickstart on Mon Aug 20 16:51:02 2018.
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 adaptive's documentation!
7 
+====================================
8 
+
9 
+.. toctree::
10 
+   :maxdepth: 2
11 
+   :caption: Contents:
12 
+
13 
+
14 
+
15 
+Indices and tables
16 
+==================
17 
+
18 
+* :ref:`genindex`
19 
+* :ref:`modindex`
20 
+* :ref:`search`