-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5236207
commit 395e626
Showing
209 changed files
with
51,142 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Docutils is a modular system for processing documentation | ||
into useful formats, such as HTML, XML, and LaTeX. For | ||
input Docutils supports reStructuredText, an easy-to-read, | ||
what-you-see-is-what-you-get plaintext markup syntax. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
Metadata-Version: 2.0 | ||
Name: docutils | ||
Version: 0.14 | ||
Summary: Docutils -- Python Documentation Utilities | ||
Home-page: http://docutils.sourceforge.net/ | ||
Author: docutils-develop list | ||
Author-email: docutils-develop@lists.sourceforge.net | ||
License: public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) | ||
Platform: OS-independent | ||
Classifier: Development Status :: 4 - Beta | ||
Classifier: Environment :: Console | ||
Classifier: Intended Audience :: End Users/Desktop | ||
Classifier: Intended Audience :: Other Audience | ||
Classifier: Intended Audience :: Developers | ||
Classifier: Intended Audience :: System Administrators | ||
Classifier: License :: Public Domain | ||
Classifier: License :: OSI Approved :: Python Software Foundation License | ||
Classifier: License :: OSI Approved :: BSD License | ||
Classifier: License :: OSI Approved :: GNU General Public License (GPL) | ||
Classifier: Operating System :: OS Independent | ||
Classifier: Programming Language :: Python :: 2.4 | ||
Classifier: Programming Language :: Python :: 2.5 | ||
Classifier: Programming Language :: Python :: 2.6 | ||
Classifier: Programming Language :: Python :: 2.7 | ||
Classifier: Programming Language :: Python :: 3 | ||
Classifier: Topic :: Documentation | ||
Classifier: Topic :: Software Development :: Documentation | ||
Classifier: Topic :: Text Processing | ||
Classifier: Natural Language :: English | ||
Classifier: Natural Language :: Afrikaans | ||
Classifier: Natural Language :: Catalan | ||
Classifier: Natural Language :: Chinese (Simplified) | ||
Classifier: Natural Language :: Chinese (Traditional) | ||
Classifier: Natural Language :: Czech | ||
Classifier: Natural Language :: Dutch | ||
Classifier: Natural Language :: Esperanto | ||
Classifier: Natural Language :: Finnish | ||
Classifier: Natural Language :: French | ||
Classifier: Natural Language :: Galician | ||
Classifier: Natural Language :: German | ||
Classifier: Natural Language :: Italian | ||
Classifier: Natural Language :: Japanese | ||
Classifier: Natural Language :: Polish | ||
Classifier: Natural Language :: Portuguese (Brazilian) | ||
Classifier: Natural Language :: Russian | ||
Classifier: Natural Language :: Slovak | ||
Classifier: Natural Language :: Spanish | ||
Classifier: Natural Language :: Swedish | ||
|
||
Docutils is a modular system for processing documentation | ||
into useful formats, such as HTML, XML, and LaTeX. For | ||
input Docutils supports reStructuredText, an easy-to-read, | ||
what-you-see-is-what-you-get plaintext markup syntax. | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Wheel-Version: 1.0 | ||
Generator: bdist_wheel (0.29.0) | ||
Root-Is-Purelib: true | ||
Tag: py2-none-any | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"classifiers": ["Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: End Users/Desktop", "Intended Audience :: Other Audience", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: Public Domain", "License :: OSI Approved :: Python Software Foundation License", "License :: OSI Approved :: BSD License", "License :: OSI Approved :: GNU General Public License (GPL)", "Operating System :: OS Independent", "Programming Language :: Python :: 2.4", "Programming Language :: Python :: 2.5", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Text Processing", "Natural Language :: English", "Natural Language :: Afrikaans", "Natural Language :: Catalan", "Natural Language :: Chinese (Simplified)", "Natural Language :: Chinese (Traditional)", "Natural Language :: Czech", "Natural Language :: Dutch", "Natural Language :: Esperanto", "Natural Language :: Finnish", "Natural Language :: French", "Natural Language :: Galician", "Natural Language :: German", "Natural Language :: Italian", "Natural Language :: Japanese", "Natural Language :: Polish", "Natural Language :: Portuguese (Brazilian)", "Natural Language :: Russian", "Natural Language :: Slovak", "Natural Language :: Spanish", "Natural Language :: Swedish"], "extensions": {"python.details": {"contacts": [{"email": "docutils-develop@lists.sourceforge.net", "name": "docutils-develop list", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "http://docutils.sourceforge.net/"}}}, "generator": "bdist_wheel (0.29.0)", "license": "public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt)", "metadata_version": "2.0", "name": "docutils", "platform": "OS-independent", "summary": "Docutils -- Python Documentation Utilities", "version": "0.14"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
docutils |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,262 @@ | ||
# $Id: __init__.py 8147 2017-08-03 09:01:16Z grubert $ | ||
# Author: David Goodger <goodger@python.org> | ||
# Copyright: This module has been placed in the public domain. | ||
|
||
""" | ||
This is the Docutils (Python Documentation Utilities) package. | ||
Package Structure | ||
================= | ||
Modules: | ||
- __init__.py: Contains component base classes, exception classes, and | ||
Docutils version information. | ||
- core.py: Contains the ``Publisher`` class and ``publish_*()`` convenience | ||
functions. | ||
- frontend.py: Runtime settings (command-line interface, configuration files) | ||
processing, for Docutils front-ends. | ||
- io.py: Provides a uniform API for low-level input and output. | ||
- nodes.py: Docutils document tree (doctree) node class library. | ||
- statemachine.py: A finite state machine specialized for | ||
regular-expression-based text filters. | ||
Subpackages: | ||
- languages: Language-specific mappings of terms. | ||
- parsers: Syntax-specific input parser modules or packages. | ||
- readers: Context-specific input handlers which understand the data | ||
source and manage a parser. | ||
- transforms: Modules used by readers and writers to modify DPS | ||
doctrees. | ||
- utils: Contains the ``Reporter`` system warning class and miscellaneous | ||
utilities used by readers, writers, and transforms. | ||
utils/urischemes.py: Contains a complete mapping of known URI addressing | ||
scheme names to descriptions. | ||
- utils/math: Contains functions for conversion of mathematical notation | ||
between different formats (LaTeX, MathML, text, ...). | ||
- writers: Format-specific output translators. | ||
""" | ||
|
||
import sys | ||
|
||
|
||
__docformat__ = 'reStructuredText' | ||
|
||
__version__ = '0.14' | ||
"""Docutils version identifier (complies with PEP 440):: | ||
major.minor[.micro][releaselevel[serial]][.dev] | ||
* The major number will be bumped when the project is feature-complete, and | ||
later if there is a major change in the design or API. | ||
* The minor number is bumped whenever there are new features. | ||
* The micro number is bumped for bug-fix releases. Omitted if micro=0. | ||
* The releaselevel identifier is used for pre-releases, one of 'a' (alpha), | ||
'b' (beta), or 'rc' (release candidate). Omitted for final releases. | ||
* The serial release number identifies prereleases; omitted if 0. | ||
* The '.dev' suffix indicates active development, not a release, before the | ||
version indicated. | ||
For version comparison operations, use `__version_info__` | ||
rather than parsing the text of `__version__`. | ||
""" | ||
|
||
# workaround for Python < 2.6: | ||
__version_info__ = (0, 14, 0, 'final', 0, True) | ||
# To add in Docutils 0.15, replacing the line above: | ||
""" | ||
from collections import namedtuple | ||
VersionInfo = namedtuple( | ||
'VersionInfo', 'major minor micro releaselevel serial release') | ||
__version_info__ = VersionInfo( | ||
major=0, | ||
minor=15, | ||
micro=0, | ||
releaselevel='alpha', # development status: | ||
# one of 'alpha', 'beta', 'candidate', 'final' | ||
serial=0, # pre-release number (0 for final releases) | ||
release=False # True for official releases and pre-releases | ||
) | ||
Comprehensive version information tuple. Can be used to test for a | ||
minimally required version, e.g. :: | ||
if __version_info__ >= (0, 13, 0, 'candidate', 2, True) | ||
or in a self-documenting way like :: | ||
if __version_info__ >= docutils.VersionInfo( | ||
major=0, minor=13, micro=0, | ||
releaselevel='candidate', serial=2, release=True) | ||
""" | ||
|
||
__version_details__ = '' | ||
"""Optional extra version details (e.g. 'snapshot 2005-05-29, r3410'). | ||
(For development and release status see `__version_info__`.) | ||
""" | ||
|
||
|
||
class ApplicationError(StandardError): | ||
# Workaround: | ||
# In Python < 2.6, unicode(<exception instance>) calls `str` on the | ||
# arg and therefore, e.g., unicode(StandardError(u'\u234')) fails | ||
# with UnicodeDecodeError. | ||
if sys.version_info < (2,6): | ||
def __unicode__(self): | ||
return u', '.join(self.args) | ||
|
||
|
||
class DataError(ApplicationError): pass | ||
|
||
|
||
class SettingsSpec: | ||
|
||
""" | ||
Runtime setting specification base class. | ||
SettingsSpec subclass objects used by `docutils.frontend.OptionParser`. | ||
""" | ||
|
||
settings_spec = () | ||
"""Runtime settings specification. Override in subclasses. | ||
Defines runtime settings and associated command-line options, as used by | ||
`docutils.frontend.OptionParser`. This is a tuple of: | ||
- Option group title (string or `None` which implies no group, just a list | ||
of single options). | ||
- Description (string or `None`). | ||
- A sequence of option tuples. Each consists of: | ||
- Help text (string) | ||
- List of option strings (e.g. ``['-Q', '--quux']``). | ||
- Dictionary of keyword arguments sent to the OptionParser/OptionGroup | ||
``add_option`` method. | ||
Runtime setting names are derived implicitly from long option names | ||
('--a-setting' becomes ``settings.a_setting``) or explicitly from the | ||
'dest' keyword argument. | ||
Most settings will also have a 'validator' keyword & function. The | ||
validator function validates setting values (from configuration files | ||
and command-line option arguments) and converts them to appropriate | ||
types. For example, the ``docutils.frontend.validate_boolean`` | ||
function, **required by all boolean settings**, converts true values | ||
('1', 'on', 'yes', and 'true') to 1 and false values ('0', 'off', | ||
'no', 'false', and '') to 0. Validators need only be set once per | ||
setting. See the `docutils.frontend.validate_*` functions. | ||
See the optparse docs for more details. | ||
- More triples of group title, description, options, as many times as | ||
needed. Thus, `settings_spec` tuples can be simply concatenated. | ||
""" | ||
|
||
settings_defaults = None | ||
"""A dictionary of defaults for settings not in `settings_spec` (internal | ||
settings, intended to be inaccessible by command-line and config file). | ||
Override in subclasses.""" | ||
|
||
settings_default_overrides = None | ||
"""A dictionary of auxiliary defaults, to override defaults for settings | ||
defined in other components. Override in subclasses.""" | ||
|
||
relative_path_settings = () | ||
"""Settings containing filesystem paths. Override in subclasses. | ||
Settings listed here are to be interpreted relative to the current working | ||
directory.""" | ||
|
||
config_section = None | ||
"""The name of the config file section specific to this component | ||
(lowercase, no brackets). Override in subclasses.""" | ||
|
||
config_section_dependencies = None | ||
"""A list of names of config file sections that are to be applied before | ||
`config_section`, in order (from general to specific). In other words, | ||
the settings in `config_section` are to be overlaid on top of the settings | ||
from these sections. The "general" section is assumed implicitly. | ||
Override in subclasses.""" | ||
|
||
|
||
class TransformSpec: | ||
|
||
""" | ||
Runtime transform specification base class. | ||
TransformSpec subclass objects used by `docutils.transforms.Transformer`. | ||
""" | ||
|
||
def get_transforms(self): | ||
"""Transforms required by this class. Override in subclasses.""" | ||
if self.default_transforms != (): | ||
import warnings | ||
warnings.warn('default_transforms attribute deprecated.\n' | ||
'Use get_transforms() method instead.', | ||
DeprecationWarning) | ||
return list(self.default_transforms) | ||
return [] | ||
|
||
# Deprecated; for compatibility. | ||
default_transforms = () | ||
|
||
unknown_reference_resolvers = () | ||
"""List of functions to try to resolve unknown references. Unknown | ||
references have a 'refname' attribute which doesn't correspond to any | ||
target in the document. Called when the transforms in | ||
`docutils.tranforms.references` are unable to find a correct target. The | ||
list should contain functions which will try to resolve unknown | ||
references, with the following signature:: | ||
def reference_resolver(node): | ||
'''Returns boolean: true if resolved, false if not.''' | ||
If the function is able to resolve the reference, it should also remove | ||
the 'refname' attribute and mark the node as resolved:: | ||
del node['refname'] | ||
node.resolved = 1 | ||
Each function must have a "priority" attribute which will affect the order | ||
the unknown_reference_resolvers are run:: | ||
reference_resolver.priority = 100 | ||
Override in subclasses.""" | ||
|
||
|
||
class Component(SettingsSpec, TransformSpec): | ||
|
||
"""Base class for Docutils components.""" | ||
|
||
component_type = None | ||
"""Name of the component type ('reader', 'parser', 'writer'). Override in | ||
subclasses.""" | ||
|
||
supported = () | ||
"""Names for this component. Override in subclasses.""" | ||
|
||
def supports(self, format): | ||
""" | ||
Is `format` supported by this component? | ||
To be used by transforms to ask the dependent component if it supports | ||
a certain input context or output format. | ||
""" | ||
return format in self.supported |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# $Id: _compat.py 7486 2012-07-11 12:25:14Z milde $ | ||
# Author: Georg Brandl <georg@python.org> | ||
# Copyright: This module has been placed in the public domain. | ||
|
||
""" | ||
Python 2/3 compatibility definitions. | ||
This module currently provides the following helper symbols: | ||
* bytes (name of byte string type; str in 2.x, bytes in 3.x) | ||
* b (function converting a string literal to an ASCII byte string; | ||
can be also used to convert a Unicode string into a byte string) | ||
* u_prefix (unicode repr prefix: 'u' in 2.x, '' in 3.x) | ||
(Required in docutils/test/test_publisher.py) | ||
* BytesIO (a StringIO class that works with bytestrings) | ||
""" | ||
|
||
import sys | ||
|
||
if sys.version_info < (3,0): | ||
b = bytes = str | ||
u_prefix = 'u' | ||
from StringIO import StringIO as BytesIO | ||
else: | ||
import builtins | ||
bytes = builtins.bytes | ||
u_prefix = '' | ||
def b(s): | ||
if isinstance(s, str): | ||
return s.encode('latin1') | ||
elif isinstance(s, bytes): | ||
return s | ||
else: | ||
raise TypeError("Invalid argument %r for b()" % (s,)) | ||
# using this hack since 2to3 "fixes" the relative import | ||
# when using ``from io import BytesIO`` | ||
BytesIO = __import__('io').BytesIO | ||
|
||
if sys.version_info < (2,5): | ||
import __builtin__ | ||
|
||
def __import__(name, globals={}, locals={}, fromlist=[], level=-1): | ||
"""Compatibility definition for Python 2.4. | ||
Silently ignore the `level` argument missing in Python < 2.5. | ||
""" | ||
# we need the level arg because the default changed in Python 3.3 | ||
return __builtin__.__import__(name, globals, locals, fromlist) |
Oops, something went wrong.