[pgrouting-dev] Documentation update

Stephen Woodbridge woodbri at swoodbridge.com
Sun May 5 10:07:53 PDT 2013


Hi Daniel,

Thanks, this is great!

I'm wondering is we can't just save whatever theme we decide to use in 
git and reference it from there?

Also I an thinking that we should install out doc when we do make 
install but I'm not sure where they should get installed to.

We should probably note in the Readme that the built doc tree exists in 
the build/html/

Lots of good work on your part.

Thanks,
   -Steve

On 5/5/2013 11:37 AM, Daniel Kastl wrote:
> I have added a bit of documentation to "sew-devel-2_0" branch.
> And I started using a theme named "Cloud Sphinx Theme" (
> http://pythonhosted.org/cloud_sptheme/), because I like it and got tired
> of the default theme ;-)
>
> To be able to compile with documentation it's now necessary to install
> the theme as well (http://pythonhosted.org/cloud_sptheme/install.html),
> which is easy if Sphinx is installed already.
> I updated the Readme accordingly:
> https://github.com/pgrouting/pgrouting/tree/sew-devel-2_0#compilation
>
> I started adding documentation for
>
>   * Dijkstra
>   * Return types
>
> For the functions I'm following
> https://docs.google.com/spreadsheet/ccc?key=0AiIg1pkkh_MRdGQzOEhyaXlndkN3eHdGNkpyQ0pMZFE&usp=sharing
>
> I found it a bit inconvenient to have Dijkstra "core" and "wrapper"
> functions documented together, so I split it into two pages even if the
> function name is the same.
> I tried to follow the documentation of PostGIS, but this only worked partly.
>
> Daniel
>
>
> --
> Georepublic UG & Georepublic Japan
> eMail: daniel.kastl at georepublic.de <mailto:daniel.kastl at georepublic.de>
> Web: http://georepublic.de <http://georepublic.de/>
>
>
> _______________________________________________
> pgrouting-dev mailing list
> pgrouting-dev at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/pgrouting-dev
>



More information about the pgrouting-dev mailing list