[Checkins] SVN: zope.structuredtext/trunk/docs/ Add basic Sphinx docs.
Tres Seaver
tseaver at palladion.com
Fri Apr 30 18:10:22 EDT 2010
Log message for revision 111787:
Add basic Sphinx docs.
Changed:
A zope.structuredtext/trunk/docs/
A zope.structuredtext/trunk/docs/Makefile
A zope.structuredtext/trunk/docs/_build/
A zope.structuredtext/trunk/docs/_static/
A zope.structuredtext/trunk/docs/_templates/
A zope.structuredtext/trunk/docs/api.rst
A zope.structuredtext/trunk/docs/conf.py
A zope.structuredtext/trunk/docs/index.rst
A zope.structuredtext/trunk/docs/make.bat
-=-
Added: zope.structuredtext/trunk/docs/Makefile
===================================================================
--- zope.structuredtext/trunk/docs/Makefile (rev 0)
+++ zope.structuredtext/trunk/docs/Makefile 2010-04-30 22:10:21 UTC (rev 111787)
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/zopestructuredtext.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zopestructuredtext.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Added: zope.structuredtext/trunk/docs/api.rst
===================================================================
--- zope.structuredtext/trunk/docs/api.rst (rev 0)
+++ zope.structuredtext/trunk/docs/api.rst 2010-04-30 22:10:21 UTC (rev 111787)
@@ -0,0 +1,50 @@
+:mod:`zope.structuredtext` API
+==============================
+
+:mod:`zope.structuredtext.document`
+-----------------------------------
+
+.. automodule:: zope.structuredtext.document
+ :members:
+
+
+:mod:`zope.structuredtext.stletters`
+------------------------------------
+
+.. automodule:: zope.structuredtext.stletters
+ :members:
+
+
+:mod:`zope.structuredtext.stng`
+-------------------------------
+
+.. automodule:: zope.structuredtext.stng
+ :members:
+
+
+:mod:`zope.structuredtext.stdom`
+--------------------------------
+
+.. automodule:: zope.structuredtext.stdom
+ :members:
+
+
+:mod:`zope.structuredtext.html`
+-------------------------------
+
+.. automodule:: zope.structuredtext.html
+ :members:
+
+
+:mod:`zope.structuredtext.docbook`
+----------------------------------
+
+.. automodule:: zope.structuredtext.docbook
+ :members:
+
+
+:mod:`zope.structuredtext`
+--------------------------
+
+.. automodule:: zope.structuredtext
+ :members:
Added: zope.structuredtext/trunk/docs/conf.py
===================================================================
--- zope.structuredtext/trunk/docs/conf.py (rev 0)
+++ zope.structuredtext/trunk/docs/conf.py 2010-04-30 22:10:21 UTC (rev 111787)
@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*-
+#
+# zope.structuredtext documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr 30 17:11:17 2010.
+#
+# 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.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os, pkg_resources
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.append(os.path.abspath('../src'))
+rqmt = pkg_resources.require('zope.structuredtext')[0]
+
+# -- 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 = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'zope.structuredtext'
+copyright = u'2010, Zope Foundation and Contributors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '3.5.0'
+# The full version, including alpha/beta/rc tags.
+release = '3.5.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# 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 = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# 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.
+#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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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
+
+# 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 false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'zopestructuredtextdoc'
+
+
+# -- 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, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'zopestructuredtext.tex', u'zope.structuredtext Documentation',
+ u'Zope Foundation and Contributors', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# 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
Added: zope.structuredtext/trunk/docs/index.rst
===================================================================
--- zope.structuredtext/trunk/docs/index.rst (rev 0)
+++ zope.structuredtext/trunk/docs/index.rst 2010-04-30 22:10:21 UTC (rev 111787)
@@ -0,0 +1,134 @@
+:mod:`zope.structuredtext` Documentation
+========================================
+
+Using Structured Text
+---------------------
+
+The goal of StructuredText is to make it possible to express
+structured text using a relatively simple plain text format. Simple
+structures, like bullets or headings are indicated through
+conventions that are natural, for some definition of
+"natural". Hierarchical structures are indicated through
+indentation. The use of indentation to express hierarchical
+structure is inspired by the Python programming language.
+
+Use of StructuredText consists of one to three logical steps. In the
+first step, a text string is converted to a network of objects using
+the :func:`structurize` facility, as in the following example:
+
+.. code-block:: python
+
+ raw = open("mydocument.txt").read()
+ from zope.structuredtext.stng import structurize
+ st = structurize(raw)
+
+The output of :func:`structurize` is simply a :class:`StructuredTextDocument`
+object containing :class:`StructuredTextParagraph` objects arranged in a
+hierarchy. Paragraphs are delimited by strings of two or more
+whitespace characters beginning and ending with newline
+characters. Hierarchy is indicated by indentation. The indentation
+of a paragraph is the minimum number of leading spaces in a line
+containing non-white-space characters after converting tab
+characters to spaces (assuming a tab stop every eight characters).
+
+:class:`StructuredTextNode` objects support the read-only subset of the
+Document Object Model (DOM) API. It should be possible to process
+:class:`StructuredTextNode` hierarchies using XML tools such as XSLT.
+
+The second step in using StructuredText is to apply additional
+structuring rules based on text content. A variety of differentText
+rules can be used. Typically, these are used to implement a
+structured text language for producing documents, but any sort of
+structured text language could be implemented in the second
+step. For example, it is possible to use StructuredText to implement
+structured text formats for representing structured data. The second
+step, which could consist of multiple processing steps, is
+performed by processing, or "coloring", the hierarchy of generic
+StructuredTextParagraph objects into a network of more specialized
+objects. Typically, the objects produced should also implement the DOM
+API to allow processing with XML tools.
+
+A document processor is provided to convert a StructuredTextDocument
+object containing only StructuredTextParagraph objects into a
+StructuredTextDocument object containing a richer collection of
+objects such as bullets, headings, emphasis, and so on using hints
+in the text. Hints are selected based on conventions of the sort
+typically seen in electronic mail or news-group postings. It should
+be noted, however, that these conventions are somewhat culturally
+dependent, fortunately, the document processor is easily customized
+to implement alternative rules. Here's an example of using the DOC
+processor to convert the output of the previous example:
+
+.. code-block:: python
+
+ from zope.structuredtext.document import Document
+ doc = Document()(st)
+
+The final step is to process the colored networks produced from the
+second step to produce additional outputs. The final step could be
+performed by Python programs, or by XML tools. A Python outputter is
+provided for the document processor output that produces Hypertext Markup
+Language (HTML) text:
+
+.. code-block:: python
+
+ from zope.structuredtext.html import HTML
+ html = HTML()(doc)
+
+
+Customizing the document processor
+----------------------------------
+
+The document processor is driven by two tables. The first table,
+named ``paragraph_types``, is a sequence of callable objects or method
+names for coloring paragraphs. If a table entry is a string, then it
+is the name of a method of the document processor to be used. For
+each input paragraph, the objects in the table are called until one
+returns a value (not 'None'). The value returned replaces the
+original input paragraph in the output. If none of the objects in
+the paragraph types table return a value, then a copy of the
+original paragraph is used. The new object returned by calling a
+paragraph type should implement the ``ReadOnlyDOM``,
+``StructuredTextColorizable``, and ``StructuredTextSubparagraphContainer``
+interfaces. See the :mod:`zope.structuredtext.document` source file for
+examples.
+
+A paragraph type may return a list or tuple of replacement
+paragraphs, this allowing a paragraph to be split into multiple
+paragraphs.
+
+The second table, ``text_types``, is a sequence of callable objects or
+method names for coloring text. The callable objects in this table
+are used in sequence to transform the input text into new text or
+objects. The callable objects are passed a string and return
+nothing (``None``) or a three-element tuple consisting of:
+
+- a replacement object,
+
+- a starting position, and
+
+- an ending position
+
+The text from the starting position is (logically) replaced with the
+replacement object. The replacement object is typically an object
+that implements that implements the ``ReadOnlyDOM`` and
+``StructuredTextColorizable`` interfaces. The replacement object can
+also be a string or a list of strings or objects. Replacement is
+done from beginning to end and text after the replacement ending
+position will be passed to the character type objects for processing.
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Added: zope.structuredtext/trunk/docs/make.bat
===================================================================
--- zope.structuredtext/trunk/docs/make.bat (rev 0)
+++ zope.structuredtext/trunk/docs/make.bat 2010-04-30 22:10:21 UTC (rev 111787)
@@ -0,0 +1,113 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp 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
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\zopestructuredtext.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\zopestructuredtext.ghc
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
More information about the checkins
mailing list