aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-07 07:06:22 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-10-07 07:41:14 -0400
commite14e95941120eb62ac22b9c9b9284048e4efd12d (patch)
treea6301ee98be7248c5670e9fdcc737831b5611d8b
parented59489f576f373aa19ad6338d272506737a1734 (diff)
downloadlibrambutan-e14e95941120eb62ac22b9c9b9284048e4efd12d.tar.gz
librambutan-e14e95941120eb62ac22b9c9b9284048e4efd12d.zip
added docs readme file
-rw-r--r--docs/README28
-rw-r--r--docs/source/conf.py25
2 files changed, 43 insertions, 10 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000..8556dd2
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,28 @@
+This directory contains the Sphinx documentation for libmaple. You
+can generate HTML documentation using the Makefile if you have make,
+or using make.bat from Windows.
+
+For the impatient, you can build the HTML docs with (on Unix):
+
+ $ sudo easy_install -U Sphinx
+ $ make html
+
+Which will produce HTML documentation in build/html.
+
+All of the documentation itself lives in source/. The directory
+source/_static is for static content like style sheets;
+source/_templates contains Sphinx templates.
+
+The documentation is written in reStructuredText (reST); it's a Python
+thing that they use to produce the docs at python.org (which are
+beautiful, if you've never seen them). You can read more about Sphinx
+here:
+
+ http://sphinx.pocoo.org/tutorial.html
+
+Specific information on documenting C and C++ is available here:
+
+ http://sphinx.pocoo.org/domains.html
+
+The file source/conf.py is an autogenerated configuration file; you
+can read it yourself.
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7eb6782..c12ebb9 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -3,7 +3,8 @@
# libmaple documentation build configuration file, created by
# sphinx-quickstart on Thu Oct 7 06:42:30 2010.
#
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile()d with the current directory set to its
+# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
@@ -18,14 +19,17 @@ import sys, os
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
-# -- General configuration -----------------------------------------------------
+# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage']
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
+ 'sphinx.ext.coverage']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -66,7 +70,8 @@ release = '0.0.7'
# directories to ignore when looking for source files.
exclude_patterns = []
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -87,7 +92,7 @@ pygments_style = 'sphinx'
#modindex_common_prefix = []
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
@@ -167,7 +172,7 @@ html_static_path = ['_static']
htmlhelp_basename = 'libmapledoc'
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
@@ -176,7 +181,7 @@ htmlhelp_basename = 'libmapledoc'
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
+# (source start file, target file, title, author, documentclass [howto/manual])
latex_documents = [
('index', 'libmaple.tex', u'libmaple Documentation',
u'Marti Bolivar, Perry Hung, Andrew Meyer, Brian Newbold', 'manual'),
@@ -206,7 +211,7 @@ latex_documents = [
#latex_domain_indices = True
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output -------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).