search

goerz / gc3pie

Automatically exported from code.google.com/p/gc3pie
0 stars 0 forks source link

make `REAMDE.txt` script documentation also available on the web site #439

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
There are quite a few scripts in GC3Apps that are documented in the
form of a `README.txt` file.

The same content should be provided in the "official" documentation on
gc3pie.readthedocs.org.

A convenient way to do it would be the following:

0. ensure that the `README.txt` files are valid reStructuredText documents
1. create the application-specific documentation file in `docs/users/gc3apps`
2. in that file, include the `README.txt` using a relative path::

        .. include:: ../../../gc3apps/whatever/README.txt

Original issue reported on code.google.com by riccardo.murri@gmail.com on 16 May 2014 at 10:13