[Python-modules-commits] [bitstruct] 06/12: Import bitstruct_2.1.3.orig.tar.gz
Brian May
bam at moszumanska.debian.org
Sat Mar 26 04:40:10 UTC 2016
This is an automated email from the git hooks/post-receive script.
bam pushed a commit to branch master
in repository bitstruct.
commit 1a078db8ec439151c7a3793e796ce5d876192ab4
Author: Brian May <brian at linuxpenguins.xyz>
Date: Thu Mar 24 19:46:43 2016 +1100
Import bitstruct_2.1.3.orig.tar.gz
---
LICENSE | 22 ++++
MANIFEST.in | 7 +
Makefile | 6 +
PKG-INFO | 19 ++-
README.rst | 17 ++-
bitstruct.egg-info/PKG-INFO | 19 ++-
bitstruct.egg-info/SOURCES.txt | 11 +-
bitstruct.py | 103 +++++++++------
docs/Makefile | 192 +++++++++++++++++++++++++++
docs/conf.py | 287 +++++++++++++++++++++++++++++++++++++++++
docs/index.rst | 20 +++
docs/make.bat | 263 +++++++++++++++++++++++++++++++++++++
setup.py | 2 +-
tests/__init__.py | 0
tests/test_bitstruct.py | 177 +++++++++++++++++++++++++
15 files changed, 1097 insertions(+), 48 deletions(-)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8241ca1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Erik Moqvist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..5b03e37
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,7 @@
+include LICENSE
+include Makefile
+recursive-include docs *.bat
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
+recursive-include tests *.py
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..69ae14f
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,6 @@
+# create release and upload to pypi
+
+all:
+ python setup.py sdist
+ python setup.py bdist_wheel --universal
+ twine upload dist/*
diff --git a/PKG-INFO b/PKG-INFO
index 3b40873..e14c2df 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: bitstruct
-Version: 2.0.2
+Version: 2.1.3
Summary: This module performs conversions between Python values and C bit field structs represented as Python bytearrays.
Home-page: https://github.com/eerimoq/bitstruct
Author: Erik Moqvist, Ilya Petukhov
@@ -71,13 +71,26 @@ Description: |buildstatus|_
>>> calcsize('u5s5f32b1r13')
56
+ The same format and values as in the previous example, but using LSB
+ (Least Significant Bit) first instead of the default MSB (Most
+ Significant Bit) first:
+
+ .. code-block:: python
+
+ >>> from bitstruct import *
+ >>> pack('<u5s5f32b1r13', 1, -1, 3.75, True, bytearray(b'\xff\xff'))
+ bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff')
+ >>> unpack('<u5s5f32b1r13', bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff'))
+ (1, -1, 3.75, True, bytearray(b'\xff\xf8'))
+ >>> calcsize('<u5s5f32b1r13')
+ 56
+
An example of unpacking values from a hexstring and a binary file:
.. code-block:: python
>>> from bitstruct import *
- >>> from binascii import *
- >>> unpack('s17s13r24', bytearray(unhexlify('0123456789abcdef')))
+ >>> unpack('s17s13r24', bytearray('0123456789abcdef'.decode('hex')))
(582, -3751, bytearray(b'\xe2j\xf3'))
>>> with open("test.bin", "rb") as fin:
... unpack('s17s13r24', bytearray(fin.read(8)))
diff --git a/README.rst b/README.rst
index 7194e4b..3bc2172 100644
--- a/README.rst
+++ b/README.rst
@@ -63,13 +63,26 @@ a float, a boolean and a bytearray:
>>> calcsize('u5s5f32b1r13')
56
+The same format and values as in the previous example, but using LSB
+(Least Significant Bit) first instead of the default MSB (Most
+Significant Bit) first:
+
+.. code-block:: python
+
+ >>> from bitstruct import *
+ >>> pack('<u5s5f32b1r13', 1, -1, 3.75, True, bytearray(b'\xff\xff'))
+ bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff')
+ >>> unpack('<u5s5f32b1r13', bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff'))
+ (1, -1, 3.75, True, bytearray(b'\xff\xf8'))
+ >>> calcsize('<u5s5f32b1r13')
+ 56
+
An example of unpacking values from a hexstring and a binary file:
.. code-block:: python
>>> from bitstruct import *
- >>> from binascii import *
- >>> unpack('s17s13r24', bytearray(unhexlify('0123456789abcdef')))
+ >>> unpack('s17s13r24', bytearray('0123456789abcdef'.decode('hex')))
(582, -3751, bytearray(b'\xe2j\xf3'))
>>> with open("test.bin", "rb") as fin:
... unpack('s17s13r24', bytearray(fin.read(8)))
diff --git a/bitstruct.egg-info/PKG-INFO b/bitstruct.egg-info/PKG-INFO
index 3b40873..e14c2df 100644
--- a/bitstruct.egg-info/PKG-INFO
+++ b/bitstruct.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: bitstruct
-Version: 2.0.2
+Version: 2.1.3
Summary: This module performs conversions between Python values and C bit field structs represented as Python bytearrays.
Home-page: https://github.com/eerimoq/bitstruct
Author: Erik Moqvist, Ilya Petukhov
@@ -71,13 +71,26 @@ Description: |buildstatus|_
>>> calcsize('u5s5f32b1r13')
56
+ The same format and values as in the previous example, but using LSB
+ (Least Significant Bit) first instead of the default MSB (Most
+ Significant Bit) first:
+
+ .. code-block:: python
+
+ >>> from bitstruct import *
+ >>> pack('<u5s5f32b1r13', 1, -1, 3.75, True, bytearray(b'\xff\xff'))
+ bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff')
+ >>> unpack('<u5s5f32b1r13', bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff'))
+ (1, -1, 3.75, True, bytearray(b'\xff\xf8'))
+ >>> calcsize('<u5s5f32b1r13')
+ 56
+
An example of unpacking values from a hexstring and a binary file:
.. code-block:: python
>>> from bitstruct import *
- >>> from binascii import *
- >>> unpack('s17s13r24', bytearray(unhexlify('0123456789abcdef')))
+ >>> unpack('s17s13r24', bytearray('0123456789abcdef'.decode('hex')))
(582, -3751, bytearray(b'\xe2j\xf3'))
>>> with open("test.bin", "rb") as fin:
... unpack('s17s13r24', bytearray(fin.read(8)))
diff --git a/bitstruct.egg-info/SOURCES.txt b/bitstruct.egg-info/SOURCES.txt
index fbfd09b..9728917 100644
--- a/bitstruct.egg-info/SOURCES.txt
+++ b/bitstruct.egg-info/SOURCES.txt
@@ -1,7 +1,16 @@
+LICENSE
+MANIFEST.in
+Makefile
README.rst
bitstruct.py
setup.py
bitstruct.egg-info/PKG-INFO
bitstruct.egg-info/SOURCES.txt
bitstruct.egg-info/dependency_links.txt
-bitstruct.egg-info/top_level.txt
\ No newline at end of file
+bitstruct.egg-info/top_level.txt
+docs/Makefile
+docs/conf.py
+docs/index.rst
+docs/make.bat
+tests/__init__.py
+tests/test_bitstruct.py
\ No newline at end of file
diff --git a/bitstruct.py b/bitstruct.py
index a288b2a..7ab0c53 100644
--- a/bitstruct.py
+++ b/bitstruct.py
@@ -3,11 +3,18 @@ import struct
def _parse_format(fmt):
- types = re.findall(r'[a-zA-Z]+', fmt)
- sizes = map(lambda size: int(size),
- re.findall(r'\d+', fmt))
-
- return zip(types, sizes)
+ parsed_infos = re.findall(r'([<>]?)([a-zA-Z])(\d+)', fmt)
+
+ # Use big endian as default and use the endianness of the previous
+ # value if none is given for the current value.
+ infos = []
+ endianness = ">"
+ for info in parsed_infos:
+ if info[0] != "":
+ endianness = info[0]
+ infos.append((info[1], int(info[2]), endianness))
+
+ return infos
def _pack_integer(size, arg):
@@ -39,10 +46,10 @@ def _pack_bytearray(size, arg):
return bits[0:size]
-def _unpack_integer(type, bits):
+def _unpack_integer(_type, bits):
value = int(bits, 2)
- if type == 's':
+ if _type == 's':
if bits[0] == '1':
value -= (1 << len(bits))
@@ -83,14 +90,20 @@ def pack(fmt, *args):
a multiple of 8, padding will be added at the end of the last
byte.
- :param fmt: Bitstruct format string.
+ :param fmt: Bitstruct format string. See format description below.
:param args: Variable argument list of values to pack.
- :returns: Bytearray of packed values.
-
- `fmt` is a string of type-length pairs. There are six types; 'u',
- 's', 'f', 'b', 'r' and 'p'. Length is the number of bits to pack
- the value into.
-
+ :returns: A bytearray of the packed values.
+
+ `fmt` is a string of bitorder-type-length groups. Bitorder may be
+ omitted.
+
+ Bitorder is either ">" or "<", where ">" means MSB first and "<"
+ means LSB first. If bitorder is omitted, the previous values'
+ bitorder is used for the current value. For example, in the format
+ string "u1<u2u3" u1 is MSB first and both u2 and u3 are LSB first.
+
+ There are six types; 'u', 's', 'f', 'b', 'r' and 'p'.
+
- 'u' -- unsigned integer
- 's' -- signed integer
- 'f' -- floating point number of 32 or 64 bits
@@ -98,6 +111,8 @@ def pack(fmt, *args):
- 'r' -- raw, bytearray
- 'p' -- padding, ignore
+ Length is the number of bits to pack the value into.
+
Example format string: 'u1u3p7s16'
"""
@@ -106,20 +121,26 @@ def pack(fmt, *args):
infos = _parse_format(fmt)
i = 0
- for type, size in infos:
- if type == 'p':
+ for _type, size, endianness in infos:
+ if _type == 'p':
bits += size * '0'
else:
- if type in 'us':
- bits += _pack_integer(size, args[i])
- elif type == 'f':
- bits += _pack_float(size, args[i])
- elif type == 'b':
- bits += _pack_boolean(size, args[i])
- elif type == 'r':
- bits += _pack_bytearray(size, args[i])
+ if _type in 'us':
+ value_bits = _pack_integer(size, args[i])
+ elif _type == 'f':
+ value_bits = _pack_float(size, args[i])
+ elif _type == 'b':
+ value_bits = _pack_boolean(size, args[i])
+ elif _type == 'r':
+ value_bits = _pack_bytearray(size, args[i])
else:
- raise ValueError("bad type '{}' in format".format(type))
+ raise ValueError("bad type '{}' in format".format(_type))
+
+ # reverse the bit order in little endian values
+ if endianness == "<":
+ value_bits = value_bits[::-1]
+
+ bits += value_bits
i += 1
# padding of last byte
@@ -138,7 +159,7 @@ def unpack(fmt, data):
:param fmt: Bitstruct format string. See pack() for details.
:param data: Bytearray of values to unpack.
- :returns: Tuple of unpacked values.
+ :returns: A tuple of the unpacked values.
"""
@@ -147,20 +168,26 @@ def unpack(fmt, data):
res = []
i = 0
- for type, size in infos:
- if type == 'p':
+ for _type, size, endianness in infos:
+ if _type == 'p':
pass
else:
- if type in 'us':
- value = _unpack_integer(type, bits[i:i+size])
- elif type == 'f':
- value = _unpack_float(size, bits[i:i+size])
- elif type == 'b':
- value = _unpack_boolean(bits[i:i+size])
- elif type == 'r':
- value = _unpack_bytearray(size, bits[i:i+size])
+ value_bits = bits[i:i+size]
+
+ # reverse the bit order in little endian values
+ if endianness == "<":
+ value_bits = value_bits[::-1]
+
+ if _type in 'us':
+ value = _unpack_integer(_type, value_bits)
+ elif _type == 'f':
+ value = _unpack_float(size, value_bits)
+ elif _type == 'b':
+ value = _unpack_boolean(value_bits)
+ elif _type == 'r':
+ value = _unpack_bytearray(size, value_bits)
else:
- raise ValueError("bad type '{}' in format".format(type))
+ raise ValueError("bad type '{}' in format".format(_type))
res.append(value)
i += size
@@ -176,7 +203,7 @@ def calcsize(fmt):
"""
- return sum([size for _, size in _parse_format(fmt)])
+ return sum([size for _, size, _ in _parse_format(fmt)])
def byteswap(fmt, data, offset = 0):
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..32f226a
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,192 @@
+# 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 coverage 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 " 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)"
+
+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/bitstruct.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/bitstruct.qhc"
+
+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."
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/bitstruct"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/bitstruct"
+ @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."
+
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.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..94c0fdc
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,287 @@
+# -*- coding: utf-8 -*-
+#
+# bitstruct documentation build configuration file, created by
+# sphinx-quickstart on Sat Apr 25 11:54:09 2015.
+#
+# 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
+import shlex
+
+# 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.autodoc',
+ 'sphinx.ext.viewcode',
+]
+
+# 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'bitstruct'
+copyright = u'2015, Erik Moqvist'
+author = u'Erik Moqvist'
+
+# 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 = '2.1.3'
+# The full version, including alpha/beta/rc tags.
+release = '2.1.3'
+
+# 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 = 'sphinx_rtd_theme'
+
+# 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 = 'bitstructdoc'
+
+# -- 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': '',
+
+# 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, 'bitstruct.tex', u'bitstruct Documentation',
+ u'Erik Moqvist', '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, 'bitstruct', u'bitstruct 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, 'bitstruct', u'bitstruct Documentation',
+ author, 'bitstruct', '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/index.rst b/docs/index.rst
new file mode 100644
index 0000000..f1d59aa
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. bitstruct documentation master file, created by
+ sphinx-quickstart on Sat Apr 25 11:54:09 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. toctree::
+ :maxdepth: 2
+
+bitstruct - Interpret strings as packed binary data
+===================================================
+
+.. include:: ../README.rst
+
+Functions
+=========
+
+.. autofunction:: bitstruct.pack
+.. autofunction:: bitstruct.unpack
+.. autofunction:: bitstruct.calcsize
+.. autofunction:: bitstruct.byteswap
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..c8d8331
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,263 @@
+ at 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
+ echo. coverage to run coverage check of 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
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%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
+)
+
+:sphinx_ok
+
+
+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
+)
+
... 372 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/bitstruct.git
More information about the Python-modules-commits
mailing list