docs/source/index.rst
changeset 3327 512eb20b0c3d
parent 3324 e1b661e5f494
child 3335 dca0a0de468c
equal deleted inserted replaced
3326:ce725978d11c 3327:512eb20b0c3d
     1 .. reportlab documentation master file, created by
     1 .. reportlab documentation master file, created by
     2    sphinx-quickstart on Fri Feb  5 21:41:03 2010.
     2    sphinx-quickstart on Fri Feb  5 21:41:03 2010.
     3    You can adapt this file completely to your liking, but it should at least
     3    You can adapt this file completely to your liking, but it should at least
     4    contain the root `toctree` directive.
     4    contain the root `toctree` directive.
     5 
     5 
     6 Welcome to the Reportlab PDF Library documentation!
     6 ===================================
     7 =====================================
     7 ReportLab PDF Toolkit documentation
       
     8 ===================================
       
     9 
       
    10 .. rubric:: API references and more for the ReportLab PDF Toolkit
       
    11 
     8 
    12 
     9 Contents:
    13 Contents:
    10 
    14 
    11 .. toctree::
    15 .. toctree::
    12    :maxdepth: 2
    16    :maxdepth: 2
    13 
    17 
       
    18    Library reference <lib.rst>
       
    19     
       
    20 
    14 Actually, that's an exaggeration.  We're just playing with Sphinx at the moment.
    21 Actually, that's an exaggeration.  We're just playing with Sphinx at the moment.
    15 Pay no attention to the Sphinx docs until this page says something more
    22 Pay no attention to the Sphinx docs until this page says something more
    16 constructive!
    23 constructive!
    17 
    24 
       
    25 We're planning to use Sphinx for the automated API references.  We have
       
    26 always been able to make our own documents in PDF, without using other
       
    27 peoples' libraries,. and don't want to back away from this. So, the main
       
    28 User Guide will remain in PDF format for now.  However, programmers need
       
    29 API refs online, and we want to learn Sphinx (and use rst2pdf) in due
       
    30 course.
       
    31 
       
    32  :ref:`API reference <api>` |
    18 
    33 
    19 Indices and tables
    34 Indices and tables
    20 ==================
    35 ==================
    21 
    36 
    22 * :ref:`genindex`
    37 * :ref:`genindex`
    23 * :ref:`modindex`
    38 * :ref:`modindex`
    24 * :ref:`search`
    39 * :ref:`search`
    25 
    40 
       
    41 
       
    42