[Checkins] SVN: z3c.form/branches/pcardune-sphinx/ add files
required to build sphinx documentation.
Paul Carduner
paulcarduner at gmail.com
Thu Apr 24 02:06:50 EDT 2008
Log message for revision 85686:
add files required to build sphinx documentation.
Changed:
A z3c.form/branches/pcardune-sphinx/.static/
A z3c.form/branches/pcardune-sphinx/.templates/
A z3c.form/branches/pcardune-sphinx/Makefile
A z3c.form/branches/pcardune-sphinx/conf.py
A z3c.form/branches/pcardune-sphinx/index.txt
-=-
Added: z3c.form/branches/pcardune-sphinx/Makefile
===================================================================
--- z3c.form/branches/pcardune-sphinx/Makefile (rev 0)
+++ z3c.form/branches/pcardune-sphinx/Makefile 2008-04-24 06:06:49 UTC (rev 85686)
@@ -0,0 +1,68 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web htmlhelp latex changes linkcheck
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " web to make files usable by Sphinx.web"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview over all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+
+clean:
+ -rm -rf .build/*
+
+html:
+ mkdir -p .build/html .build/doctrees
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+ @echo
+ @echo "Build finished. The HTML pages are in .build/html."
+
+web:
+ mkdir -p .build/web .build/doctrees
+ $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web
+ @echo
+ @echo "Build finished; now you can run"
+ @echo " python -m sphinx.web .build/web"
+ @echo "to start the server."
+
+htmlhelp:
+ mkdir -p .build/htmlhelp .build/doctrees
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in .build/htmlhelp."
+
+latex:
+ mkdir -p .build/latex .build/doctrees
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in .build/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ mkdir -p .build/changes .build/doctrees
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
+ @echo
+ @echo "The overview file is in .build/changes."
+
+linkcheck:
+ mkdir -p .build/linkcheck .build/doctrees
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in .build/linkcheck/output.txt."
Property changes on: z3c.form/branches/pcardune-sphinx/Makefile
___________________________________________________________________
Name: svn:eol-style
+ native
Added: z3c.form/branches/pcardune-sphinx/conf.py
===================================================================
--- z3c.form/branches/pcardune-sphinx/conf.py (rev 0)
+++ z3c.form/branches/pcardune-sphinx/conf.py 2008-04-24 06:06:49 UTC (rev 85686)
@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+#
+# z3c.form documentation build configuration file, created by
+# sphinx-quickstart on Wed Apr 23 23:01:11 2008.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default value; values that are commented out
+# serve to show the default value.
+
+import sys
+
+# If your extensions are in another directory, add it here.
+#sys.path.append('some/directory')
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'z3c.form'
+copyright = '2008, Stephan Richter, Roger Ineichen and the Zope Community'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '1.8'
+# The full version, including alpha/beta/rc tags.
+release = '1.8.2dev'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['.static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Content template for the index page.
+#html_index = ''
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'z3c.formdoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+#latex_documents = []
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
Property changes on: z3c.form/branches/pcardune-sphinx/conf.py
___________________________________________________________________
Name: svn:keywords
+ Id
Name: svn:eol-style
+ native
Added: z3c.form/branches/pcardune-sphinx/index.txt
===================================================================
--- z3c.form/branches/pcardune-sphinx/index.txt (rev 0)
+++ z3c.form/branches/pcardune-sphinx/index.txt 2008-04-24 06:06:49 UTC (rev 85686)
@@ -0,0 +1,38 @@
+.. z3c.form documentation master file, created by sphinx-quickstart on Wed Apr 23 23:01:11 2008.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to z3c.form's documentation!
+====================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ src/z3c/form/README
+ src/z3c/form/action
+ src/z3c/form/adding
+ src/z3c/form/button
+ src/z3c/form/converter
+ src/z3c/form/datamanager
+ src/z3c/form/error
+ src/z3c/form/field
+ src/z3c/form/form
+ src/z3c/form/group
+ src/z3c/form/subform
+ src/z3c/form/term
+ src/z3c/form/util
+ src/z3c/form/validator
+ src/z3c/form/value
+ src/z3c/form/widget
+ src/z3c/form/zcml
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Property changes on: z3c.form/branches/pcardune-sphinx/index.txt
___________________________________________________________________
Name: svn:eol-style
+ native
More information about the Checkins
mailing list