Changeset 1070

Show
Ignore:
Timestamp:
06/28/08 12:16:35 (2 months ago)
Author:
mattknox_ca
Message:

doc infrastructure enhancements

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/timeseries/scikits/timeseries/doc/conf.py

    r1062 r1070  
    1818# is relative to the documentation root, use os.path.abspath to make it 
    1919# absolute, like shown here. 
    20 #sys.path.append(os.path.abspath('some/directory')) 
     20sys.path.append(os.path.abspath('sphinxext')) 
    2121 
    2222# General configuration 
    …… 
    2525# Add any Sphinx extension module names here, as strings. They can be extensions 
    2626# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    27 #extensions = [] 
     27extensions = ['sphinx.ext.autodoc', 'only_directives'] 
    2828 
    2929# Add any paths that contain templates here, relative to this directory. 
    …… 
    3838# General substitutions. 
    3939project = 'scikits.timeseries' 
    40 copyright = '2008, Pierre GF GERARD-MARCHANT, Matt KNOX' 
     40copyright = '2008, Pierre GF Gerard-Marchant, Matt Knox' 
    4141 
    4242# The default replacements for |version| and |release|, also used in various 
    …… 
    138138# contain a <link> tag referring to it.  The value of this option must be the 
    139139# base URL from which the finished HTML is served. 
    140 #html_use_opensearch = '' 
     140html_use_opensearch = 'False' 
    141141 
    142142# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 
    …… 
    151151 
    152152# The paper size ('letter' or 'a4'). 
    153 #latex_paper_size = 'letter' 
     153latex_paper_size = 'letter' 
    154154 
    155155# The font size ('10pt', '11pt' or '12pt'). 
    156 #latex_font_size = '10pt' 
     156latex_font_size = '11pt' 
    157157 
    158158# Grouping the document tree into LaTeX files. List of tuples 
    159159# (source start file, target name, title, author, document class [howto/manual]). 
    160160latex_documents = [ 
    161   ('index', 'scikitstimeseries.tex', 'scikits.timeseries Documentation', 'Pierre GF GERARD-MARCHANT & Matt KNOX', 'manual'), 
     161  ('index', 'scikitstimeseries.tex', 'scikits.timeseries Documentation', 'Pierre GF Gerard-Marchant, Matt Knox', 'manual'), 
    162162] 
    163163 
    164164# The name of an image file (relative to this directory) to place at the top of 
    165165# the title page. 
    166 #latex_logo = None 
    167  
    168 # For "manual" documents, if this is true, then toplevel headings are parts, 
    169 # not chapters. 
    170 #latex_use_parts = False 
     166latex_logo = None 
    171167 
    172168# Additional stuff for the LaTeX preamble. 
    173 #latex_preamble = '' 
     169latex_preamble = '' 
    174170 
    175171# Documents to append as an appendix to all manuals. 
    176 #latex_appendices = [] 
     172latex_appendices = [] 
    177173 
    178174# If false, no module index is generated. 
    179 #latex_use_modindex = True 
     175latex_use_modindex = True 
     176 
     177#latex_use_parts = True 
     178 
     179# Show both class-level docstring and __init__ docstring in class 
     180# documentation 
     181autoclass_content = 'both' 

  • trunk/timeseries/scikits/timeseries/doc/index.rst

    r1062 r1070  
    1 ################## 
    2 scikits.timeseries 
    3 ################## 
     1################### 
     2 scikits.timeseries 
     3################### 
    44 
    5 :Release: |version| 
    6 :Date: |today| 
     5.. htmlonly:: 
    76 
    8 Contents: 
     7    :Release: |version| 
     8    :Date: |today| 
    99 
    1010.. toctree:: 
    …… 
    1414   installing.rst 
    1515 
    16 Indices and tables 
    17 ================== 
     16.. htmlonly:: 
    1817 
    19 * :ref:`genindex` 
    20 * :ref:`modindex` 
    21 * :ref:`search` 
     18  * :ref:`genindex` 
     19  * :ref:`modindex` 
     20  * :ref:`search`