sandbox/dkuhlman/README_docpy

   1 =======================================================
   2 Python LaTeX -- reStructuredText for Documenting Python
   3 =======================================================
   4
   5
   6 What it does -- Python LaTeX generates LaTeX suitable as input to
   7 the "Documenting Python" system.  This system is described at:
   8
   9     http://www.python.org/dev/doc/devel/doc/doc.html
  10
  11
  12 Installation
  13 ------------
  14
  15 If you have a standard Docutils installation, then you should be
  16 able to go to the parent directory of the ``docutils`` directory,
  17 then do the following::
  18
  19     unzip rstdocpy-1.0b.zip
  20
  21 This will create (overlay) the following files::
  22
  23     README_docpy
  24     Docs/Makefile
  25     Docs/pythonlatex_intro.txt
  26     docutils/docs/rst/docpy.html
  27     docutils/docutils/writers/python_latex.py
  28     docutils/tools/python_latex.py
  29
  30 In order to use the above files in place, you may have to do
  31 something like::
  32
  33     export PYTHONPATH=/w1/Python/DocUtils/docutils:$PYTHONPATH
  34
  35 You will also need the "Documenting Python" tools installed.  They
  36 are in the ``Doc`` directory of the Python source code
  37 distribution.
  38
  39
  40 Testing
  41 -------
  42
  43 After the above installation, you should be able to go to the
  44 ``Msgs`` directory and convert the document ``docpy_intro.rst``.
  45
  46 First, edit the file ``Msgs/Makefile``.  Change the path that
  47 points to the location where the Python source code is installed.
  48 Then type::
  49
  50     cd Msgs
  51     make clean
  52     make
  53
  54
  55 Documentation
  56 -------------
  57
  58 The file ``Msgs/docpy_intro.rst`` contains an introduction.
  59
  60 See the companion document 'Quick reStructuredText for
  61 "Documenting Python"' (docutils/docs/rst/docpy.html) for
  62 additional mark-up that can be used when generating LaTeX for
  63 "Documenting Python". The first section of this document has
  64 information specific to the generation of LaTeX for Documenting
  65 Python. In addition, that document also adds another column to the
  66 specification tables.  This additional column describes the LaTeX
  67 commands generated by this writer.
  68
  69
  70 More Information
  71 ----------------
  72
  73 Find out more about Docutils at::
  74
  75     http://docutils.sourceforge.net/
  76
  77 More information about the Documenting Python system is at::
  78
  79     http://www.python.org/dev/doc/devel/doc/doc.html
  80
  81
  82 Acknowledgements
  83 -----------------
  84
  85 Thanks to the Docutils project members for Docutils.  In
  86 particular, thanks to project coordinator David Goodger.
  87
  88 Thanks to Engelbert Gruber for the implementation of the latex
  89 writer.  That implementation formed the starting point for this
  90 writer.  He should get much of the credit for this writer also,
  91 however, any bugs were likely introduced by me.
  92
  93
  94 Contact
  95 -------
  96
  97 Please let me know about suggestions and problems::
  98
  99     Dave Kuhlman
 100     dkuhlman@rexx.com
 101     http://www.rexx.com/~dkuhlman
 102