Changeset 674


Ignore:
Timestamp:
Dec 30, 2015, 12:04:32 PM (4 years ago)
Author:
cito
Message:

Convert from Docutils to Sphinx for good

Make the switch to using Sphinx exclusively for generating the docs.
Rename all reST files to .rst so editors like PyCharm? automatically
will use syntax highlighting and linting for the reST format.

Files:
6 deleted
4 edited
27 moved

Legend:

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

    r669 r674  
    3939# You can specify multiple suffix as a list of string:
    4040# source_suffix = ['.rst', '.md']
    41 source_suffix = '.txt'
     41source_suffix = '.rst'
    4242
    4343# The encoding of source files.
  • branches/4.x/mkdocs

    r263 r674  
    11#! /bin/sh
    22
    3 echo "Making HTML docs..."
     3# small safety test
     4if [ ! -f module/pgmodule.c ]
     5then
     6        echo "Hmmm.  Are you sure you are in the right directory?"
     7        exit 1
     8fi
    49
    5 python ./buildhtml.py --stylesheet docs.css --link-stylesheet --prune=docs/CVS docs
     10echo "Making Sphinx docs..."
    611
     12cd docs
     13make html
  • trunk/docs/conf.py

    r669 r674  
    3939# You can specify multiple suffix as a list of string:
    4040# source_suffix = ['.rst', '.md']
    41 source_suffix = '.txt'
     41source_suffix = '.rst'
    4242
    4343# The encoding of source files.
  • trunk/docs/pg.rst

    r673 r674  
    502502
    503503Connection -- The connection object
    504 =================================
     504===================================
    505505
    506506.. class:: Connection
     
    11831183
    11841184Query methods
    1185 =====================
     1185=============
    11861186
    11871187.. class:: Query
  • trunk/mkdocs

    r263 r674  
    11#! /bin/sh
    22
    3 echo "Making HTML docs..."
     3# small safety test
     4if [ ! -f module/pgmodule.c ]
     5then
     6        echo "Hmmm.  Are you sure you are in the right directory?"
     7        exit 1
     8fi
    49
    5 python ./buildhtml.py --stylesheet docs.css --link-stylesheet --prune=docs/CVS docs
     10echo "Making Sphinx docs..."
    611
     12cd docs
     13make html
Note: See TracChangeset for help on using the changeset viewer.