Package the Document

Sphinx

  1. Write the ‘setup.py’

    Write a setup with imported setupdocx classes, for a complete example refer to Source.

    1
2
3
4
5
6
7
    #
# setup extension modules
#
from setupdocx import usage, sed

# documents
from setupdocx.dist_docx import DistDocX

    Add a custom class:

    1
2
3
4
5
6
7
    class dist_docx(DistDocX):
    """Defines additional text processing.
    """

    def __init__(self, *args, **kargs):
        DistDocX.__init__(self, *args, **kargs)
        self.name = 'setupdocx'

    Integrate into distutils [distutils]:

    1
2
3
4
    setup(
    cmdclass={
        'dist_docx': dist_docx,
    },

  2. Call the ‘setup.py’

    Package the document into a file archive:

    python setup.py dist_docx --name-in=<your-docname>

    The package is created by default in the standard distribution directory of the current project. The default type is zip:

    dist/<docname>-<release>.zip

See also EXAMPLES.

Epydoc

available soon