[Python-modules-commits] [ruamel.yaml] 01/06: Import ruamel.yaml_0.11.11.orig.tar.gz
Vincent Bernat
bernat at moszumanska.debian.org
Sat May 21 15:05:02 UTC 2016
This is an automated email from the git hooks/post-receive script.
bernat pushed a commit to branch master
in repository ruamel.yaml.
commit eef955ca3518072814e84efd9a068413befadf71
Author: Vincent Bernat <bernat at debian.org>
Date: Sat May 21 16:51:18 2016 +0200
Import ruamel.yaml_0.11.11.orig.tar.gz
---
.hg_archival.txt | 4 +-
.hgignore | 1 +
.hgtags | 12 ++
CHANGES | 11 ++
README.rst | 277 ++-------------------------------------
__init__.py | 5 +-
_doc/Makefile | 216 +++++++++++++++++++++++++++++++
_doc/conf.py | 287 +++++++++++++++++++++++++++++++++++++++++
README.rst => _doc/detail.rst | 237 +++++++++++++++++-----------------
_doc/example.rst | 102 +++++++++++++++
_doc/index.rst | 23 ++++
_doc/install.rst | 31 +++++
_doc/links.rst | 7 +
_doc/overview.rst | 31 +++++
_doc/pyyaml.rst | 68 ++++++++++
_test/lib/canonical.py | 22 +++-
_test/lib/test_all.py | 6 +-
_test/lib/test_appliance.py | 6 +-
_test/lib/test_build.py | 11 +-
_test/lib/test_build_ext.py | 11 +-
_test/lib/test_canonical.py | 16 ++-
_test/lib/test_constructor.py | 97 +++++++++-----
_test/lib/test_emitter.py | 16 ++-
_test/lib/test_errors.py | 7 +-
_test/lib/test_input_output.py | 40 +++---
_test/lib/test_mark.py | 2 +-
_test/lib/test_reader.py | 5 +-
_test/lib/test_recursive.py | 7 +-
_test/lib/test_representer.py | 4 +-
_test/lib/test_resolver.py | 17 ++-
_test/lib/test_structure.py | 22 +++-
_test/lib/test_yaml.py | 24 ++--
_test/roundtrip.py | 33 +++--
_test/test_anchor.py | 1 -
_test/test_comments.py | 134 +++++++++++++------
_test/test_fail.py | 214 ++++++++++++++++++++++++++++++
_test/test_indentation.py | 286 ++++++++++++++++++++++++++++------------
_test/test_tag.py | 32 +++++
_test/test_version.py | 104 +++++++++++++++
_test/test_z_data.py | 5 +-
comments.py | 33 ++++-
compat.py | 16 ++-
composer.py | 2 +
configobjwalker.py | 68 +---------
constructor.py | 54 ++++++--
cyaml.py | 14 +-
dumper.py | 32 +++--
emitter.py | 121 ++++++++++-------
error.py | 10 +-
events.py | 1 +
example/anchor_merge.py | 1 -
example/so_13517753.py | 42 +++---
ext/_ruamel_yaml.c | 12 +-
ext/_ruamel_yaml.pyx | 2 +-
loader.py | 26 ++--
main.py | 72 +++++++++--
make_win_whl.py | 34 -----
nodes.py | 2 +
parser_.py => parser.py | 40 ++++--
reader.py | 6 +-
representer.py | 23 +++-
resolver.py | 166 +++++++++++++++++++++++-
scalarstring.py | 2 +
scanner.py | 8 +-
serializer.py | 32 ++---
setup.py | 15 ++-
tokens.py | 3 +
tox.ini | 2 +-
util.py | 139 ++++++++++++++++++++
69 files changed, 2490 insertions(+), 922 deletions(-)
diff --git a/.hg_archival.txt b/.hg_archival.txt
index d0cd5d6..3f3782a 100644
--- a/.hg_archival.txt
+++ b/.hg_archival.txt
@@ -1,4 +1,4 @@
repo: e99c8d58f995a8f13dfbeadbf4dbcbe458caccb0
-node: e18897e2dfc1fbd0f4949675390804b7c5cf9177
+node: 9870512ae409df49e9528954a072a9772e68125f
branch: default
-tag: 0.10.23
+tag: 0.11.11
diff --git a/.hgignore b/.hgignore
index 0426bfb..a80e935 100644
--- a/.hgignore
+++ b/.hgignore
@@ -24,3 +24,4 @@ venv
convert
cmd
TODO.rst
+_doc/_build
diff --git a/.hgtags b/.hgtags
index 0521b3b..aa98814 100644
--- a/.hgtags
+++ b/.hgtags
@@ -6,3 +6,15 @@ a79ba7f0cc8fa5d68518893a3f10e17676e67046 0.10.17
71814e979983a45be5feea16815becba232593e1 0.10.19
74915d2345dfde360479b94a5975da36711b4d6e 0.10.20
c78d15d315599670be54141ca8c96e050fabca2e 0.10.22
+e18897e2dfc1fbd0f4949675390804b7c5cf9177 0.10.23
+302116269a34dfbe94d9d38ea3d51afe3651d45e 0.11.0
+37f1b713fec62c079a49135771be21a7a204ca84 0.11.1
+a1efab2dfcc7f3e1be345715e0363c6ae99c6bf9 0.11.2
+447f5942c2fc26fbe8c6c7fe525976bb75854876 0.11.3
+b6ea93b67e983fd38fc3835b723aca5edc4e94b8 0.11.4
+89d31eebace0c036541c1f23d36450106e5b78cb 0.11.5
+1416683886f050f4475355ae026c07f1d8553759 0.11.6
+417dcdd367bad9a6b0e19ff9088fd8f933c544df 0.11.7
+2309d082da2d8ffca483112089223f0b77c6876e 0.11.8
+12756d40a6d4cf21af22e125ea019c32a94282b1 0.11.9
+0574cc19d4ca1d123ef45d09e4b879daab2f2c46 0.11.10
diff --git a/CHANGES b/CHANGES
index f7590e6..50c7e6f 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,14 @@
+
+0.11.10 2016-05-02
+
+- added .insert(pos, key, value, comment=None) to CommentedMap
+
+0.11.10 2016-04-19
+
+- indent=2, block_seq_indent=2 works as expected
+
+<To be updated>
+
0.10.11: 2015-09-17
- Fix issue 13: dependency on libyaml to be installed for yaml.h
diff --git a/README.rst b/README.rst
index 582e451..bcdd7d2 100644
--- a/README.rst
+++ b/README.rst
@@ -2,273 +2,22 @@
ruamel.yaml
===========
-Starting with 0.10.7 the package has been reorganised and the
-command line utility is in its own package ``ruamel.yaml.cmd`` (so
-installing ``ruamel.yaml`` doesn't pull in possibly irrelevant modules
-only used in the command line utility)
+``ruamel.yaml`` is a YAML 1.2 loader/dumper package for Python.
-``ruamel.yaml`` is a YAML package for Python. It is a derivative
-of Kirill Simonov's `PyYAML 3.11 <https://bitbucket.org/xi/pyyaml>`_
-which supports YAML1.1
+* `Overview <http://yaml.readthedocs.org/en/latest/overview.html>`_
+* `Installing <http://yaml.readthedocs.org/en/latest/install.html>`_
+* `Details <http://yaml.readthedocs.org/en/latest/detail.html>`_
+* `Examples <http://yaml.readthedocs.org/en/latest/example.html>`_
+* `Differences with PyYAML <http://yaml.readthedocs.org/en/latest/pyyaml.html>`_
-Major differences with PyYAML 3.11:
+.. image:: https://readthedocs.org/projects/yaml/badge/?version=stable
+ :target: https://yaml.readthedocs.org/en/stable
-- integrated Python 2 and 3 sources, running on Python 2.6, 2.7 (CPython,
- PyPy), 3.3 and 3.4.
-- round trip mode that **includes comments** (block mode, key ordering kept)
-- support for simple lists as mapping keys by transforming these to tuples
-- ``!!omap`` generates ordereddict (C) on Python 2, collections.OrderedDict
- on Python 3, and ``!!omap`` is generated for these types.
-- some `YAML 1.2 <http://yaml.org/spec/1.2/spec.html>`_ enhancements
- (``0o`` octal prefix, ``\/`` escape)
-- pep8 compliance
-- tox and py.test based testing
-- Tests whether the C yaml library is installed as well as the header
- files. That library doesn't generate CommentTokens, so it cannot be used to
- do round trip editing on comments. It can be used to speed up normal
- processing (so you don't need to install ``ruamel.yaml`` and ``PyYaml``).
- See the section *Optional requirements*.
-- Basic support for multiline strings with preserved newlines and
- chomping ( '``|``', '``|+``', '``|-``' ). As this subclasses the string type
- the information is lost on reassignment. (This might be changed
- in the future so that the preservation/folding/chomping is part of the
- parent container, like comments).
-- RoundTrip preservation of flow style sequences ( 'a: b, c, d') (based
- on request and test by Anthony Sottile)
-- anchors names that are hand-crafted (not of the form``idNNN``) are preserved
-- `merges <http://yaml.org/type/merge.html>`_ in dictionaries are preserved
-- adding/replacing comments on block-style sequences and mappings
- with smart column positioning
-- collection objects (when read in via RoundTripParser) have an ``lc``
- property that contains line and column info ``lc.line`` and ``lc.col``.
- Individual positions for mappings and sequences can also be retrieved
- (``lc.key('a')``, ``lc.value('a')`` resp. ``lc.item(3)``)
-- preservation of whitelines after block scalars. Contributed by Sam Thursfield.
-
-Round trip including comments
-=============================
-
-The major motivation for this fork is the round-trip capability for
-comments. The integration of the sources was just an initial step to
-make this easier.
-
-adding/replacing comments
--------------------------
-
-Starting with version 0.8, you can add/replace comments on block style
-collections (mappings/sequences resuting in Python dict/list). The basic
-for for this is::
-
- from __future__ import print_function
-
- import ruamel.yaml
-
- inp = """\
- abc:
- - a # comment 1
- xyz:
- a: 1 # comment 2
- b: 2
- c: 3
- d: 4
- e: 5
- f: 6 # comment 3
- """
-
- data = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
- data['abc'].append('b')
- data['abc'].yaml_add_eol_comment('comment 4', 1) # takes column of comment 1
- data['xyz'].yaml_add_eol_comment('comment 5', 'c') # takes column of comment 2
- data['xyz'].yaml_add_eol_comment('comment 6', 'e') # takes column of comment 3
- data['xyz'].yaml_add_eol_comment('comment 7', 'd', column=20)
-
- print(ruamel.yaml.dump(data, Dumper=ruamel.yaml.RoundTripDumper), end='')
-
-.. example code add_comment.py
-
-Resulting in::
-
- abc:
- - a # comment 1
- - b # comment 4
- xyz:
- a: 1 # comment 2
- b: 2
- c: 3 # comment 5
- d: 4 # comment 7
- e: 5 # comment 6
- f: 6 # comment 3
-
-
-.. example output add_comment.py
-
-
-If the comment doesn't start with '#', this will be added. The key is
-the element index for list, the actual key for dictionaries. As can be seen
-from the example, the column to choose for a comment is derived
-from the previous, next or preceding comment column (picking the first one
-found).
-
-Config file formats
-===================
-
-There are only a few configuration file formats that are easily
-readable and editable: JSON, INI/ConfigParser, YAML (XML is to cluttered
-to be called easily readable).
-
-Unfortunately `JSON <http://www.json.org/>`_ doesn't support comments,
-and although there are some solutions with pre-processed filtering of
-comments, there are no libraries that support round trip updating of
-such commented files.
-
-INI files support comments, and the excellent `ConfigObj
-<http://www.voidspace.org.uk/python/configobj.html>`_ library by Foord
-and Larosa even supports round trip editing with comment preservation,
-nesting of sections and limited lists (within a value). Retrieval of
-particular value format is explicit (and extensible).
-
-YAML has basic mapping and sequence structures as well as support for
-ordered mappings and sets. It supports scalars various types
-including dates and datetimes (missing in JSON).
-YAML has comments, but these are normally thrown away.
-
-Block structured YAML is a clean and very human readable
-format. By extending the Python YAML parser to support round trip
-preservation of comments, it makes YAML a very good choice for
-configuration files that are human readable and editable while at
-the same time interpretable and modifiable by a program.
-
-Extending
+ChangeLog
=========
-There are normally six files involved when extending the roundtrip
-capabilities: the reader, parser, composer and constructor to go from YAML to
-Python and the resolver, representer, serializer and emitter to go the other
-way.
-
-Extending involves keeping extra data around for the next process step,
-eventuallly resulting in a different Python object (subclass or alternative),
-that should behave like the original, but on the way from Python to YAML
-generates the original (or at least something much closer).
-
-Smartening
-==========
-
-When you use round-tripping, then the complex data you get are
-already subclasses of the built-in types. So you can patch
-in extra methods or override existing ones. Some methods are already
-included and you can do::
-
- yaml_str = """\
- a:
- - b:
- c: 42
- - d:
- f: 196
- e:
- g: 3.14
- """
-
-
- data = yaml.load(yaml_str, Loader=yaml.RoundTripLoader)
-
- assert data.mlget(['a', 1, 'd', 'f'], list_ok=True) == 196
-
-
-Examples
-========
-
-Basic round trip of parsing YAML to Python objects, modifying
-and generating YAML::
-
- from __future__ import print_function
-
- import ruamel.yaml
-
- inp = """\
- # example
- name:
- # details
- family: Smith # very common
- given: Alice # one of the siblings
- """
-
- code = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
- code['name']['given'] = 'Bob'
-
- print(ruamel.yaml.dump(code, Dumper=ruamel.yaml.RoundTripDumper), end='')
-
-.. example code small.py
-
-Resulting in ::
-
- # example
- name:
- # details
- family: Smith # very common
- given: Bob # one of the siblings
-
-
-.. example output small.py
-
-
-YAML handcrafted anchors and references as well as key merging
-is preserved. The merged keys can transparently be accessed
-using ``[]`` and ``.get()``::
-
- import ruamel.yaml
-
- inp = """\
- - &CENTER {x: 1, y: 2}
- - &LEFT {x: 0, y: 2}
- - &BIG {r: 10}
- - &SMALL {r: 1}
- # All the following maps are equal:
- # Explicit keys
- - x: 1
- y: 2
- r: 10
- label: center/big
- # Merge one map
- - <<: *CENTER
- r: 10
- label: center/big
- # Merge multiple maps
- - <<: [*CENTER, *BIG]
- label: center/big
- # Override
- - <<: [*BIG, *LEFT, *SMALL]
- x: 1
- label: center/big
- """
-
- data = ruamel.yaml.load(inp, ruamel.yaml.RoundTripLoader)
- assert data[7]['y'] == 2
-
-
-.. example code anchor_merge.py
-
-
-Optional requirements
-=====================
-
-If you have the C yaml library and headers installed, as well as
-the header files for your Python executables then you can use the
-non-roundtrip but faster C loader and emitter.
-
-On Debian systems you should use::
-
- sudo apt-get install libyaml-dev python-dev python3-dev
-
-you can leave out ``python3-dev`` if you don't use python3
-
-For CentOS (7) based systems you should do::
-
- sudo yum install libyaml-devel python-devel
-
-Testing
-=======
+::
-Testing is done using `tox <https://pypi.python.org/pypi/tox>`_, which
-uses `virtualenv <https://pypi.python.org/pypi/virtualenv>`_ and
-`pytest <http://pytest.org/latest/>`_.
+ 0.11.0 (2016-02-18):
+ - RoundTripLoader loads 1.2 by default (no sexagesimals, 012 octals nor
+ yes/no/on/off booleans
diff --git a/__init__.py b/__init__.py
index f9193ef..9be2082 100644
--- a/__init__.py
+++ b/__init__.py
@@ -9,13 +9,13 @@ from __future__ import absolute_import
_package_data = dict(
full_package_name="ruamel.yaml",
- version_info=(0, 10, 23),
+ version_info=(0, 11, 11),
author="Anthon van der Neut",
author_email="a.van.der.neut at ruamel.eu",
description="ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order", # NOQA
entry_points=None,
install_requires=dict(
- any=["ruamel.base>=1.0.0"],
+ any=[],
py26=["ruamel.ordereddict"],
py27=["ruamel.ordereddict"]
),
@@ -41,6 +41,7 @@ _package_data = dict(
"Topic :: Text Processing :: Markup"
],
windows_wheels=True,
+ read_the_docs='yaml',
)
diff --git a/_doc/Makefile b/_doc/Makefile
new file mode 100644
index 0000000..630532d
--- /dev/null
+++ b/_doc/Makefile
@@ -0,0 +1,216 @@
+# 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
+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 " applehelp to make an Apple Help Book"
+ @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)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+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."
+
+.PHONY: qthelp
+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/yaml.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yaml.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/yaml"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yaml"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: latex
+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)."
+
+.PHONY: latexpdf
+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."
+
+.PHONY: latexpdfja
+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."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+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)."
+
+.PHONY: info
+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."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+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."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/_doc/conf.py b/_doc/conf.py
new file mode 100644
index 0000000..e1b1eea
--- /dev/null
+++ b/_doc/conf.py
@@ -0,0 +1,287 @@
+# -*- coding: utf-8 -*-
+#
+# yaml documentation build configuration file, created by
+# sphinx-quickstart on Mon Feb 29 12:03:00 2016.
+#
+# 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 # NOQA
+import os # NOQA
+
+# 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+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'yaml'
+copyright = u'2016, Anthon van der Neut, Ruamel bvba'
+author = u'Anthon van der Neut'
+
+# 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.
+#
+try:
+ from ruamel.yaml import __version__, version_info
+ # The short X.Y version.
+ version = '.'.join(version_info[:2])
+ # The full version, including alpha/beta/rc tags.
+ release = __version__
+except:
+ version = release = 'dev'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = 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
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'yamldoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ 'papersize': 'a4paper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ # 'figure_align': 'htbp',
+}
+
+# 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 = [
+ (master_doc, 'yaml.tex', u'yaml Documentation',
+ u'Anthon van der Neut', '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 = [
+ (master_doc, 'yaml', u'yaml Documentation',
+ [author], 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 = [
+ (master_doc, 'yaml', u'yaml Documentation',
+ author, 'yaml', '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/README.rst b/_doc/detail.rst
similarity index 62%
copy from README.rst
copy to _doc/detail.rst
index 582e451..1449023 100644
--- a/README.rst
+++ b/_doc/detail.rst
@@ -1,28 +1,11 @@
+Details
+=======
-ruamel.yaml
-===========
-
-Starting with 0.10.7 the package has been reorganised and the
-command line utility is in its own package ``ruamel.yaml.cmd`` (so
-installing ``ruamel.yaml`` doesn't pull in possibly irrelevant modules
-only used in the command line utility)
-
-``ruamel.yaml`` is a YAML package for Python. It is a derivative
-of Kirill Simonov's `PyYAML 3.11 <https://bitbucket.org/xi/pyyaml>`_
-which supports YAML1.1
-Major differences with PyYAML 3.11:
-- integrated Python 2 and 3 sources, running on Python 2.6, 2.7 (CPython,
- PyPy), 3.3 and 3.4.
-- round trip mode that **includes comments** (block mode, key ordering kept)
- support for simple lists as mapping keys by transforming these to tuples
- ``!!omap`` generates ordereddict (C) on Python 2, collections.OrderedDict
... 4698 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/ruamel.yaml.git
More information about the Python-modules-commits
mailing list