Changeset 695 for branches/4.x


Ignore:
Timestamp:
Jan 6, 2016, 4:42:50 PM (4 years ago)
Author:
cito
Message:

Reorganize and improve the Sphinx docs

The Sphinx HTML docs can now also serve as home page for the project.
They can be built with the mkdocs script and can then be found in the
docs/_build/html directory (this needs sphinx and the cloud_sptheme).

The "actual" core docs can be found in docs/contents. The layout has
been modified to only show these pages with the typical documentation
relbars; the other pages of the homepage use a simpler layout. The
pg and pgdb documentation has been cut in chunks and can now be found
in docs/contents/pg and docs/contents/pgdb.

Location:
branches/4.x
Files:
35 added
11 deleted
5 edited
1 moved

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs/conf.py

    r674 r695  
    1616import shlex
    1717
    18 # import Cloud
    19 import cloud_sptheme as csp
     18# import Cloud theme
     19# this will also automatically add the theme directory
     20import cloud_sptheme
    2021
    2122# If extensions (or modules to document with autodoc) are in another directory,
     
    7778exclude_patterns = ['_build']
    7879
     80# List of pages which are included in other pages and therefore should
     81# not appear in the toctree.
     82exclude_patterns += ['about.rst',
     83    'download/download.rst', 'download/files.rst',
     84    'community/mailinglist.rst', 'community/source.rst',
     85    'community/bugtracker.rst', 'community/support.rst',
     86    'community/homes.rst']
     87
    7988# The reST default role (used for this markup: `text`) for all documents.
    8089#default_role = None
     
    113122# further.  For a list of options available for each theme, see the
    114123# documentation.
    115 html_theme_options = {'defaultcollapsed': True}
     124html_theme_options = {
     125    'roottarget': 'contents/index',
     126    'defaultcollapsed': True,
     127    'shaded_decor': True}
    116128
    117129# Add any paths that contain custom themes here, relative to this directory.
    118 html_theme_path = [csp.get_theme_dir()]
     130html_theme_path = ['_themes']
    119131
    120132# The name for this set of Sphinx documents.  If None, it defaults to
     
    132144# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    133145# pixels large.
    134 #html_favicon = None
     146html_favicon = '_static/favicon.ico'
    135147
    136148# Add any paths that contain custom static files (such as style sheets) here,
  • branches/4.x/docs/copyright.rst

    r674 r695  
    3030AUTHORS HAVE NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
    3131ENHANCEMENTS, OR MODIFICATIONS.
    32 
    33 
  • branches/4.x/docs/index.rst

    r671 r695  
    44   contain the root `toctree` directive.
    55
    6 PyGreSQL - PostgreSQL module for Python
    7 =======================================
    8 
    9 Contents:
     6Welcome to PyGreSQL
     7===================
    108
    119.. toctree::
    12    :maxdepth: 1
     10    :hidden:
    1311
    14    introduction
    15    copyright
    16    changelog
    17    install
    18    interface
    19    pg
    20    pgdb
    21    source
    22    mailinglist
    23    future
    24    examples
     12    copyright
     13    announce
     14    download/index
     15    contents/index
     16    community/index
    2517
    26 Indices and tables
    27 ==================
    28 
    29 * :ref:`genindex`
    30 * :ref:`modindex`
    31 * :ref:`search`
     18.. include:: about.rst
  • branches/4.x/mkdocs

    r687 r695  
    1414
    1515cd docs
     16${MAKE} clean
    1617${MAKE} html
  • branches/4.x/mktar

    r686 r695  
    22
    33VERSION=4.2
     4DISTDIR=/u/pyg/files
    45
    5 # small safety test
     6# small safety tests
    67if [ ! -f module/pgmodule.c ]
    78then
    89        echo "Hmmm.  Are you sure you are in the right directory?"
     10        exit 1
     11fi
     12if [ ! -d $DISTDIR ]
     13then
     14        echo "Hmmm.  Are you sure you are on the right server?"
    915        exit 1
    1016fi
     
    2430# except this also makes the docs and bundles them as source and html.
    2531
    26 DISTDIR=/u/pyg/files
    2732TD=PyGreSQL-$VERSION
    2833TF=$DISTDIR/$TD.tgz
     
    3237          module/setup.py module/setup.cfg"
    3338DOCFILES="docs/Makefile docs/make.bat docs/*.rst
    34           docs/_build/html/*.html docs/_build/html/*.js
    35           docs/_build/html/_static"
     39          docs/contents docs/download docs/community
     40          docs/_static docs/_templates"
     41HTMLFILES="docs/_build/html"
    3642TESTFILES="module/tests/*.py"
    3743TUTFILES="tutorial/*.py"
     
    4349rm -rf $TD
    4450mkdir $TD
    45 mkdir -p $TD/docs/_static
     51mkdir -p $TD/docs/_build/html
    4652mkdir $TD/tests
    4753mkdir $TD/tutorial
    4854cp $MODFILES $TD
    4955cp -r $DOCFILES $TD/docs
     56cp -r $HTMLFILES $TD/docs/_build
    5057cp $TESTFILES $TD/tests
    5158cp $TUTFILES $TD/tutorial
Note: See TracChangeset for help on using the changeset viewer.