[GRASS-dev] [GRASS GIS] #151: make documentation be full text searchable: use sphinx
GRASS GIS
trac at osgeo.org
Tue Jun 19 09:21:39 PDT 2012
#151: make documentation be full text searchable: use sphinx
-------------------------+--------------------------------------------------
Reporter: timmie | Owner: epatton
Type: enhancement | Status: assigned
Priority: major | Milestone: 7.0.0
Component: Website | Version: unspecified
Keywords: | Platform: Unspecified
Cpu: Unspecified |
-------------------------+--------------------------------------------------
Comment(by lucadelu):
Some improvements, I obtain a working version of documentation with
sphinx. I really like it but there are some think to fix.
Here the procedure (use a recent version of pandoc, older it's buggy for
me):
{{{
cd dist.x86_64-unknown-linux-gnu/docs/
mkdir rst
# convert html to rst
for i in `ls ../html/*.html`; do pandoc -s -c ../html/grassdocs.css -r
html $i -w rst -o `basename $i .html`.rst; done
# move other files
cp ../html/*.png ../html/*.jpg .
cp ../html/grassdocs.css .
cp ../html/grass_logo.txt .
cp -rf ../html/icons/ .
# start sphinx
sphinx-quickstart
# move all to source directory
mv *.rst *.png *.jpg icons/ grass* source/
# create html documentation
make html
}}}
In the next weeks I'll try to study a little bit of sphinx to fix some
problems
--
Ticket URL: <http://trac.osgeo.org/grass/ticket/151#comment:16>
GRASS GIS <http://grass.osgeo.org>
More information about the grass-dev
mailing list