Merge lp:~mwhudson/lava-kernel-ci-views/start-the-docs into lp:lava-kernel-ci-views

Proposed by Michael Hudson-Doyle
Status: Merged
Merged at revision: 104
Proposed branch: lp:~mwhudson/lava-kernel-ci-views/start-the-docs
Merge into: lp:lava-kernel-ci-views
Diff against target: 263 lines (+241/-0)
4 files modified
.bzrignore (+1/-0)
docs/changes.rst (+11/-0)
docs/conf.py (+204/-0)
docs/index.rst (+25/-0)
To merge this branch: bzr merge lp:~mwhudson/lava-kernel-ci-views/start-the-docs
Reviewer Review Type Date Requested Status
Paul Larson (community) Approve
Review via email: mp+89171@code.launchpad.net

Description of the change

Extremely bare bones sphinx docs.

To post a comment you must log in.
Revision history for this message
Michael Hudson-Doyle (mwhudson) wrote :
Revision history for this message
Paul Larson (pwlars) wrote :

cool, retroactive +1 :)
Also, you may want to add a link to it from lava-project docs

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2011-10-12 02:22:12 +0000
3+++ .bzrignore 2012-01-19 00:47:23 +0000
4@@ -1,2 +1,3 @@
5 ./*.egg-info
6 ./dist
7+./build
8
9=== added directory 'docs'
10=== added file 'docs/changes.rst'
11--- docs/changes.rst 1970-01-01 00:00:00 +0000
12+++ docs/changes.rst 2012-01-19 00:47:23 +0000
13@@ -0,0 +1,11 @@
14+Version History
15+***************
16+
17+.. _version_2012.01:
18+
19+Version 2012.01
20+===============
21+
22+ * First version to have docs on readthedocs.org
23+
24+
25
26=== added file 'docs/conf.py'
27--- docs/conf.py 1970-01-01 00:00:00 +0000
28+++ docs/conf.py 2012-01-19 00:47:23 +0000
29@@ -0,0 +1,204 @@
30+# -*- coding: utf-8 -*-
31+#
32+# LAVA Dashboard documentation build configuration file, created by
33+# sphinx-quickstart on Mon Dec 27 16:39:47 2010.
34+#
35+# This file is execfile()d with the current directory set to its containing dir.
36+#
37+# Note that not all possible configuration values are present in this
38+# autogenerated file.
39+#
40+# All configuration values have a default; values that are commented out
41+# serve to show the default.
42+
43+import sys
44+import os
45+
46+# If extensions (or modules to document with autodoc) are in another directory,
47+# add these directories to sys.path here. If the directory is relative to the
48+# documentation root, use os.path.abspath to make it absolute, like shown here.
49+sys.path.append(os.path.abspath('..'))
50+
51+# -- General configuration -----------------------------------------------------
52+
53+# Add any Sphinx extension module names here, as strings. They can be extensions
54+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
55+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage']
56+
57+# Configuration for sphinx.ext.todo
58+todo_include_todos = True
59+
60+# Add any paths that contain templates here, relative to this directory.
61+templates_path = []
62+
63+# The suffix of source filenames.
64+source_suffix = '.rst'
65+
66+# The encoding of source files.
67+#source_encoding = 'utf-8'
68+
69+# The master toctree document.
70+master_doc = 'index'
71+
72+# General information about the project.
73+project = u'LAVA Scheduler'
74+copyright = u'2010-2011, Linaro Limited'
75+
76+# The version info for the project you're documenting, acts as replacement for
77+# |version| and |release|, also used in various other places throughout the
78+# built documents.
79+#
80+# The short X.Y version.
81+import versiontools
82+import lava_kernel_ci_views_app
83+version = "%d.%d" % lava_kernel_ci_views_app.__version__[0:2]
84+# The full version, including alpha/beta/rc tags.
85+release = versiontools.format_version(lava_kernel_ci_views_app.__version__)
86+
87+# The language for content autogenerated by Sphinx. Refer to documentation
88+# for a list of supported languages.
89+#language = None
90+
91+# There are two options for replacing |today|: either, you set today to some
92+# non-false value, then it is used:
93+#today = ''
94+# Else, today_fmt is used as the format for a strftime call.
95+#today_fmt = '%B %d, %Y'
96+
97+# List of documents that shouldn't be included in the build.
98+#unused_docs = []
99+
100+# List of directories, relative to source directory, that shouldn't be searched
101+# for source files.
102+exclude_trees = []
103+
104+# The reST default role (used for this markup: `text`) to use for all documents.
105+#default_role = None
106+
107+# If true, '()' will be appended to :func: etc. cross-reference text.
108+#add_function_parentheses = True
109+
110+# If true, the current module name will be prepended to all description
111+# unit titles (such as .. function::).
112+#add_module_names = True
113+
114+# If true, sectionauthor and moduleauthor directives will be shown in the
115+# output. They are ignored by default.
116+#show_authors = False
117+
118+# The name of the Pygments (syntax highlighting) style to use.
119+pygments_style = 'sphinx'
120+
121+# A list of ignored prefixes for module index sorting.
122+#modindex_common_prefix = []
123+
124+
125+# -- Options for HTML output ---------------------------------------------------
126+
127+# The theme to use for HTML and HTML Help pages. Major themes that come with
128+# Sphinx are currently 'default' and 'sphinxdoc'.
129+html_theme = 'default'
130+
131+# Theme options are theme-specific and customize the look and feel of a theme
132+# further. For a list of options available for each theme, see the
133+# documentation.
134+#html_theme_options = {}
135+
136+# Add any paths that contain custom themes here, relative to this directory.
137+#html_theme_path = []
138+
139+# The name for this set of Sphinx documents. If None, it defaults to
140+# "<project> v<release> documentation".
141+#html_title = None
142+
143+# A shorter title for the navigation bar. Default is the same as html_title.
144+#html_short_title = None
145+
146+# The name of an image file (relative to this directory) to place at the top
147+# of the sidebar.
148+#html_logo = None
149+
150+# The name of an image file (within the static path) to use as favicon of the
151+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
152+# pixels large.
153+#html_favicon = None
154+
155+# Add any paths that contain custom static files (such as style sheets) here,
156+# relative to this directory. They are copied after the builtin static files,
157+# so a file named "default.css" will overwrite the builtin "default.css".
158+html_static_path = []
159+
160+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
161+# using the given strftime format.
162+#html_last_updated_fmt = '%b %d, %Y'
163+
164+# If true, SmartyPants will be used to convert quotes and dashes to
165+# typographically correct entities.
166+#html_use_smartypants = True
167+
168+# Custom sidebar templates, maps document names to template names.
169+#html_sidebars = {}
170+
171+# Additional templates that should be rendered to pages, maps page names to
172+# template names.
173+#html_additional_pages = {}
174+
175+# If false, no module index is generated.
176+#html_use_modindex = True
177+
178+# If false, no index is generated.
179+#html_use_index = True
180+
181+# If true, the index is split into individual pages for each letter.
182+#html_split_index = False
183+
184+# If true, links to the reST sources are added to the pages.
185+#html_show_sourcelink = True
186+
187+# If true, an OpenSearch description file will be output, and all pages will
188+# contain a <link> tag referring to it. The value of this option must be the
189+# base URL from which the finished HTML is served.
190+#html_use_opensearch = ''
191+
192+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
193+#html_file_suffix = ''
194+
195+# Output file base name for HTML help builder.
196+htmlhelp_basename = 'LAVADocumentation'
197+
198+
199+# -- Options for LaTeX output --------------------------------------------------
200+
201+# The paper size ('letter' or 'a4').
202+#latex_paper_size = 'letter'
203+
204+# The font size ('10pt', '11pt' or '12pt').
205+#latex_font_size = '10pt'
206+
207+# Grouping the document tree into LaTeX files. List of tuples
208+# (source start file, target name, title, author, documentclass [howto/manual]).
209+latex_documents = [
210+ ('index', 'LAVAScheduler.tex', u'LAVA Scheduler Documentation',
211+ u'Linaro Validation Team', 'manual'),
212+]
213+
214+# The name of an image file (relative to this directory) to place at the top of
215+# the title page.
216+#latex_logo = None
217+
218+# For "manual" documents, if this is true, then toplevel headings are parts,
219+# not chapters.
220+#latex_use_parts = False
221+
222+# Additional stuff for the LaTeX preamble.
223+#latex_preamble = ''
224+
225+# Documents to append as an appendix to all manuals.
226+#latex_appendices = []
227+
228+# If false, no module index is generated.
229+#latex_use_modindex = True
230+
231+
232+# Example configuration for intersphinx: refer to the Python standard library.
233+intersphinx_mapping = {'http://docs.python.org/': None}
234
235=== added file 'docs/index.rst'
236--- docs/index.rst 1970-01-01 00:00:00 +0000
237+++ docs/index.rst 2012-01-19 00:47:23 +0000
238@@ -0,0 +1,25 @@
239+==============
240+LAVA Kernel CI
241+==============
242+
243+Introduction
244+============
245+
246+This is just a place holder for now, sorry.
247+
248+Indices and tables
249+==================
250+
251+.. toctree::
252+ :maxdepth: 2
253+
254+ changes.rst
255+
256+* :ref:`search`
257+
258+Questions
259+^^^^^^^^^
260+.. _questions:
261+
262+If you have any questions, including to the content of this document, feel free
263+to ask them here: https://answers.launchpad.net/lava-kernel-ci-views

Subscribers

People subscribed via source and target branches

to all changes: