diff options
author | Rob Dennis <rdennis@gmail.com> | 2014-02-13 01:40:17 -0500 |
---|---|---|
committer | Rob Dennis <rdennis@gmail.com> | 2014-02-13 01:40:17 -0500 |
commit | 717af30aa0e53c633a2847ca5ecc847def69b619 (patch) | |
tree | 993baaf3f40da4a1b8e516ef6a924ebcd4c31408 | |
parent | b8a252d736dd9cc4084ff49c5db3c4e152503ad7 (diff) | |
download | configobj-git-717af30aa0e53c633a2847ca5ecc847def69b619.tar.gz |
fixes #7 and #9
Docs are now buildable with sphinx
-rw-r--r-- | docs/Makefile | 177 | ||||
-rw-r--r-- | docs/conf.py | 260 | ||||
-rw-r--r-- | docs/configobj.rst (renamed from docs/configobj.txt) | 106 | ||||
-rw-r--r-- | docs/index.rst | 24 | ||||
-rw-r--r-- | docs/make.bat | 242 | ||||
-rw-r--r-- | docs/validate.rst (renamed from docs/validate.txt) | 70 |
6 files changed, 760 insertions, 119 deletions
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..f9eb919 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +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 " singlehtml to make a single large HTML file" + @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 " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @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." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +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/configobj.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/configobj.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/configobj" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/configobj" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +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." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bbee170 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +# +# configobj documentation build configuration file, created by +# sphinx-quickstart on Sat Feb 8 01:26:54 2014. +# +# 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 +import os + +# 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.insert(0, os.path.abspath('.')) + +# -- 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.coverage', +] + +# 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-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'configobj' +copyright = u'2014, Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright' + +# 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 = '5.0.0' +# The full version, including alpha/beta/rc tags. +release = '5.0.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 patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = 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 = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'configobjdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'configobj.tex', u'configobj Documentation', + u'Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright', '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 + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'configobj', u'configobj Documentation', + [u'Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'configobj', u'configobj Documentation', + u'Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright', 'configobj', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/configobj.txt b/docs/configobj.rst index 7dab99c..b28272d 100644 --- a/docs/configobj.txt +++ b/docs/configobj.rst @@ -1,21 +1,22 @@ +.. _config_doc: + ================================== Reading and Writing Config Files ================================== ---------------------------------------- - ConfigObj 4 Introduction and Reference + ConfigObj 5 Introduction and Reference ---------------------------------------- -:Authors: Michael Foord, Nicola Larosa -:Version: ConfigObj 4.7.2 -:Date: 2010/02/27 -:Homepage: `ConfigObj Homepage`_ +:Authors: Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright +:Version: ConfigObj 5.0.0 +:Date: 2014/02/08 :PyPI Entry: `ConfigObj on PyPI <http://pypi.python.org/pypi/configobj/>`_ -:Development: `Google Code Homepage`_ +:Homepage: `Github Page`_ :License: `BSD License`_ :Support: `Mailing List`_ .. _Mailing List: http://lists.sourceforge.net/lists/listinfo/configobj-develop -.. _Google Code Homepage: http://code.google.com/p/configobj/ +.. _Github Page: https://github.com/DiffSK/configobj .. meta:: :description: ConfigObj - a Python module for easy reading and writing of @@ -25,7 +26,6 @@ .. contents:: ConfigObj Manual -.. sectnum:: .. note:: @@ -58,64 +58,24 @@ It has lots of other features though : * Full Unicode support -For support and bug reports please use the ConfigObj `Mailing List`_ or the issue tracker on the -`Google Code Homepage`_. +For support and bug reports please use the ConfigObj `Github Page`_. Downloading =========== -The current version is **4.7.2**, dated 27th February 2010. ConfigObj 4 is +The current version is **5.0.0**, dated 8th February 2014. ConfigObj 4 is stable and mature. We still expect to pick up a few bugs along the way though [#]_. -You can get ConfigObj in the following ways : - -* configobj.py_ from Voidspace - - ConfigObj has no external dependencies. This file is sufficient to access - all the functionality except Validation_. - -* configobj.zip_ from Voidspace - - This also contains validate.py_ and `this document`_. - -* validate.py_ from Voidspace - - -Installing ----------- - -ConfigObj has a source distribution `on PyPI <http://pypi.python.org/pypi/configobj/>`_. If you unzip -the archive you can install it with:: - - setup.py install - -Alternatively, you can install with easy install or pip:: - - easy_install configobj - - -Documentation -------------- - -*configobj.zip* also contains `this document`_. - -* You can view `this document`_ online at the `ConfigObj Homepage`_. +We recommend downloading and installing using easy_install or pip: + pip install configobj Development Version ------------------- -It is sometimes possible to get the latest *development version* of ConfigObj -from the Subversion Repository maintained on the `Google Code Homepage`_. - -.. _configobj.py: http://www.voidspace.org.uk/downloads/configobj.py -.. _configobj.zip: http://www.voidspace.org.uk/downloads/configobj-4.7.2.zip -.. _validate.py: http://www.voidspace.org.uk/downloads/validate.py -.. _this document: -.. _configobj homepage: http://www.voidspace.org.uk/python/configobj.html - - +It's possible to get the latest *development version* of ConfigObj +from the Git Repository maintained on the `Github Page`_. ConfigObj in the Real World =========================== @@ -580,8 +540,7 @@ validate if test == True: print 'Succeeded.' -The validate method uses the `validate -<http://www.voidspace.org.uk/python/validate.html>`__ module to do the +The validate method uses the :validate: module to do the validation. This method validates the ConfigObj against the configspec. By doing type @@ -1749,7 +1708,7 @@ configspec values then you must also pass in ``_inspec=True``. list_values=False, _inspec=True) config = ConfigObj(filename, configspec=configspec) -.. _validate.py documentation: http://www.voidspace.org.uk/python/validate.html +.. _validate.py documentation: :ref:`validate_doc` Type Conversion @@ -1848,7 +1807,7 @@ As well as using ``__many__`` to validate unspecified sections you can use it to example, to specify that all values in a section should be integers:: [section] - __many__ = integer + __many__ = integer If you want to use repeated values alongside repeated sections you can call one ``__many__`` and the other ``___many___`` (with three underscores). @@ -2308,13 +2267,12 @@ free software: test it, break it, just don't blame us if it eats your data ! Of course if it does, let us know and we'll fix the problem so it doesn't happen to anyone else:: - Copyright (c) 2004 - 2010, Michael Foord & Nicola Larosa - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are - met: - + Copyright (C) 2005-2014: + (name) : (email) + Michael Foord: fuzzyman AT voidspace DOT org DOT uk + Nicola Larosa: nico AT tekNico DOT net + Rob Dennis: rdennis AT gmail DOT com + Eli Courtwright: eli AT courtwright DOT org * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. @@ -2324,9 +2282,9 @@ happen to anyone else:: disclaimer in the documentation and/or other materials provided with the distribution. - * Neither the name of Michael Foord nor Nicola Larosa - may be used to endorse or promote products derived from this - software without specific prior written permission. + * None of the authors names may be used to endorse or + promote products derived from this software without + specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT @@ -2342,7 +2300,7 @@ happen to anyone else:: You should also be able to find a copy of this license at : `BSD License`_ -.. _BSD License: http://www.voidspace.org.uk/python/license.shtml +.. _BSD License: http://opensource.org/licenses/BSD-3-Clause TODO @@ -2377,8 +2335,7 @@ ISSUES .. note:: - Please file any bug reports to `Michael Foord`_ or the **ConfigObj** - `Mailing List`_. + Please file any bug reports at the `Github Page`_ There is currently no way to specify the encoding of a configspec file. @@ -2422,6 +2379,11 @@ CHANGELOG This is an abbreviated changelog showing the major releases up to version 4. From version 4 it lists all releases and changes. +2014/02/08 - Version 5.0.0 +-------------------------- +* Python 3 single-source compatibility at the cost of a more restrictive set of versions: 2.6, 2.7, 3.2, 3.3 (otherwise unchanged) +* New maintainers: Rob Dennis and Eli Courtwright +* New home on github 2010/02/27 - Version 4.7.2 -------------------------- @@ -2642,7 +2604,7 @@ The errors stored will be an ``UnreprError``. Added ``validate.py`` back into ``configobj.zip``. (Thanks to Stewart Midwinter) -Updated to `validate.py`_ 0.2.2. +Updated to ``validate.py`` 0.2.2. Preserve tuples when calling the ``dict`` method. (Thanks to Gustavo Niemeyer.) diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..06ff3df --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +.. configobj documentation master file, created by + sphinx-quickstart on Sat Feb 8 01:26:54 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to configobj's documentation! +===================================== + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 1 + + configobj + validate + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..8557e7a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +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. singlehtml to make a single large HTML file + 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. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + 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 +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + 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 + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\configobj.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\configobj.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + 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 + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/docs/validate.txt b/docs/validate.rst index acdb263..d438aab 100644 --- a/docs/validate.txt +++ b/docs/validate.rst @@ -1,3 +1,5 @@ +.. _validate_doc: + =================================== Validation Schema with validate.py =================================== @@ -6,25 +8,20 @@ -------------------------- -:Authors: `Michael Foord`_, `Nicola Larosa`_, `Mark Andrews`_ -:Version: Validate 1.0.1 -:Date: 2010/01/09 -:Homepage: `Validate Homepage`_ -:Repository: `Google code homepage <http://code.google.com/p/configobj/>`_ -:PyPI Entry: `Validate on Python Packaging Index <http://pypi.python.org/pypi/validate>`_ +:Authors: Michael Foord, Nicola Larosa, Rob Dennis, Eli Courtwright, Mark Andrews +:Version: Validate 2.0.0 +:Date: 2014/02/08 +:Homepage: `Github Page`_ :License: `BSD License`_ :Support: `Mailing List`_ .. _Mailing List: http://lists.sourceforge.net/lists/listinfo/configobj-develop -.. _Michael Foord: fuzzyman@voidspace.org.uk -.. _Nicola Larosa: nico@teknico.net .. _This Document: -.. _Validate Homepage: http://www.voidspace.org.uk/python/validate.html -.. _BSD License: http://www.voidspace.org.uk/python/license.shtml +.. _Github Page: https://github.com/DiffSK/configobj +.. _BSD License: http://opensource.org/licenses/BSD-3-Clause .. contents:: Validate Manual -.. sectnum:: Introduction @@ -58,50 +55,25 @@ Some standard functions are provided, for basic data types; these come built into every validator. Additional checks are easy to write: they can be provided when the ``Validator`` is instantiated, or added afterwards. -Validate was primarily written to support ConfigObj_, but is designed to be +Validate was primarily written to support ConfigObj, but is designed to be applicable to many other situations. -For support and bug reports please use the ConfigObj `Mailing List`_. - -.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html +For support and bug reports please use the ConfigObj `Github Page`_ Downloading =========== -The current version is **1.0.1**, dated 9th January 2010. +The current version is **2.0.0**, dated 8th February 2014. -You can get obtain validate in the following ways : +You can obtain validate in the following ways : Files ----- -* validate.py_ from Voidspace - -* configobj.zip from Voidspace - See the homepage of ConfigObj_ for the latest - version and download links. - - This contains validate.py and `this document`_. (As well as ConfigObj_ and - the ConfigObj documentation). - -* The latest development version can be obtained from the `Subversion Repository`_. - - -Documentation -------------- - -*configobj.zip* contains `this document`_. - -* You can view `this document`_ online as the `Validate Homepage`_. - -.. _configobj.py: http://www.voidspace.org.uk/cgi-bin/voidspace/download/configobj.py -.. _configobj.zip: http://www.voidspace.org.uk/cgi-bin/voidspace/download/configobj-4.7.0.zip -.. _validate.py: http://www.voidspace.org.uk/cgi-bin/voidspace/download/validate.py -.. _Subversion Repository: http://code.google.com/p/configobj/ -.. _Sourceforge: http://sourceforge.net/projects/configobj -.. _validate: http://www.voidspace.org.uk/python/validate.html - +* validate.py from `Github Page`_ +* The latest development version can be obtained from the `Github Page`_. The standard functions ====================== @@ -571,8 +543,7 @@ ISSUES .. note:: - Please file any bug reports to `Michael Foord`_ or the ConfigObj - `Mailing List`_. + Please file any bug reports to the `Github Page`_ If we could pull tuples out of arguments, it would be easier to specify arguments for 'mixed_lists'. @@ -581,6 +552,12 @@ to specify arguments for 'mixed_lists'. CHANGELOG ========= +2014/02/08 - Version 2.0.0 +-------------------------- +* Python 3 single-source compatibility at the cost of a more restrictive set of versions: 2.6, 2.7, 3.2, 3.3 (otherwise unchanged) +* New maintainers: Rob Dennis and Eli Courtwright +* New home on github + 2009/10/25 - Version 1.0.1 -------------------------- @@ -672,7 +649,7 @@ Moved a function call outside a try...except block. 2005/08/18 Version 0.2.0 ----------------------------- -Updated by `Michael Foord`_ and `Nicola Larosa`_ +Updated by Michael Foord and Nicola Larosa Does type conversion as well. @@ -680,7 +657,6 @@ Does type conversion as well. 2005/02/01 Version 0.1.0 ----------------------------- -Initial version developed by `Michael Foord`_ -and Mark Andrews. +Initial version developed by Michael Foord and Mark Andrews. |