update documentation

Steve Canny · Steve Canny · commit ba3c312853c1 · 2013-08-06T01:35:04.000-07:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -12,12 +12,12 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-# import sys, os
+import sys, 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('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ---------------------------------------------------
 
@@ -55,19 +55,27 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = '0.1'
 # The full version, including alpha/beta/rc tags.
 release = '0.1.0'
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
+# A string of reStructuredText that will be included at the end of every source
+# file that is read. This is the right place to add substitutions that should
+# be available in every file.
+rst_epilog = """
+.. |OpcPackage| replace:: :class:`OpcPackage`
+
+.. |PackURI| replace:: :class:`PackURI`
+
+.. |Part| replace:: :class:`Part`
+
+.. |_Relationship| replace:: :class:`_Relationship`
+
+.. |po| replace:: ``python-opc``
+
+.. |python-opc| replace:: ``python-opc``
+"""
 
-# 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.
diff --git a/doc/index.rst b/doc/index.rst
@@ -2,20 +2,92 @@
 python-opc
 ##########
 
-Contents:
+Welcome
+=======
+
+|po| is a Python library for manipulating Open Packaging Convention (OPC)
+packages. An OPC package is the file format used by Microsoft Office 2007 and
+later for Word, Excel, and PowerPoint.
+
+**STATUS: as of Jul 28 2013 python-opc and this documentation for it are both
+work in progress.**
+
+
+Documentation
+=============
+
+|OpcPackage| objects
+====================
+
+.. autoclass:: opc.OpcPackage
+   :members:
+   :member-order: bysource
+   :undoc-members:
+
+
+|Part| objects
+==============
+
+The |Part| class is the default type for package parts and also serves as the
+base class for custom part classes.
+
+.. autoclass:: opc.package.Part
+   :members:
+   :member-order: bysource
+   :undoc-members:
+
+
+|_Relationship| objects
+=======================
+
+The |_Relationship| class ...
+
+.. autoclass:: opc.package._Relationship
+   :members:
+   :member-order: bysource
+   :undoc-members:
 
-.. toctree::
-   developer/design_narratives
-   :maxdepth: 2
 
-Notes
-=====
+Concepts
+========
 
+ISO/IEC 29500 Specification
+---------------------------
 
 
+Package contents
+----------------
 
-Indices and tables
-==================
+Content types stream, package relationships, parts.
+
+
+Pack URIs
+---------
+
+... A partname is a special case of pack URI ...
+
+
+Parts
+-----
+
+
+Relationships
+-------------
+
+... target mode ... relationship type ... rId ... targets
+
+
+Content types
+-------------
+
+
+
+Contents
+========
+
+.. toctree::
+   developer/design_narratives
+   :maxdepth: 2
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/setup.py b/setup.py
@@ -28,7 +28,7 @@
 PACKAGES = ['opc']
 
 INSTALL_REQUIRES = ['lxml']
-TEST_SUITE = 'test'
+TEST_SUITE = 'tests'
 TESTS_REQUIRE = ['behave', 'mock', 'pytest']
 
 CLASSIFIERS = [
