diff options
| author | Marco Pesenti Gritti <marcopg@marcopg-sugar-lucid.(none)> | 2010-08-11 01:19:40 (GMT) |
|---|---|---|
| committer | Marco Pesenti Gritti <marcopg@marcopg-sugar-lucid.(none)> | 2010-08-11 01:19:40 (GMT) |
| commit | 6052e70894e8f0b437f2960eb20fbc759904c43c (patch) | |
| tree | 1acec7cadaa39eddbd367af7e790b0cf2c3bb707 | |
Initial sphinx template
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Makefile | 11 | ||||
| -rw-r--r-- | source/conf.py | 17 | ||||
| -rw-r--r-- | source/index.rst | 15 |
4 files changed, 44 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..52d2e5a --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +SPHINXBUILD = sphinx-build +BUILDDIR = build +SOURCEDIR = source + +html: + $(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +clean: + -rm -rf $(BUILDDIR)/* diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..58413d4 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,17 @@ +import sys, os + +source_suffix = '.rst' +master_doc = 'index' + +project = u'Sugar' +copyright = u'2010, Marco Pesenti Gritti' +version = '1.0' +release = '1.0' + +pygments_style = 'sphinx' + +extensions = ['sphinx.ext.todo'] + +# HTML output +html_theme = 'sphinxdoc' +htmlhelp_basename = 'Sugardoc' diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..729d074 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,15 @@ +Welcome to Sugar's documentation! +================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |