Documentation Process for next release step 2
- The documentation is written using ReStructuredText
The following is a guideline of the structure for the index.rst files. Things marked between brackets are to be changed acordingly
..
****************************************************************************
pgRouting Manual
Copyright(c) pgRouting Contributors
This documentation is licensed under a Creative Commons Attribution-Share
Alike 3.0 License: http://creativecommons.org/licenses/by-sa/3.0/
****************************************************************************
.. _\<section\>_functions:
\<section\> Functions
===============================================================================
\[General description of the section, may include:\]
\[short overview or description of the algorithm\]
\[A brief description of what are the feature and benefits of this algorithm.\]
[Why I might want to use it over one of the other ones.]
[High level of how the algorithm works]
[what are the inputs (high-level concepts)]
[what can be expected as results.(high-level concepts)]
- :ref:`pgr_point_to_edgenode` - convert a point geometry to a ``vertex_id`` based on closest edge.
- :ref:`pgr_flip_edges` - flip the edges in an array of geometries so the connect end to end.
- :ref:`pgr_text_to_points` - convert a string of ``x,y;x,y;...`` locations into point geometries.
- :ref:`pgr_points_to_vids` - convert an array of point geometries into vertex ids.
.. toctree:: :hidden:
pgr_pointToEdgeNode - convert a point geometry to a vertex_id based on closest edge. <point_to_edgenode>
pgr_flipEdges - flip the edges in an array of geometries so the connect end to end. <flip_edges>
pgr_textToPoints - convert a string of x,y;x,y;... locations into point geometries. <text_to_points>
-
A Developer will create documentation of a "new function"
-
A Developer will modify documentation of a "modified function" maybe because of changes in the functionality
-
User's and translators findings of typos and grammar are posted on [Issue 200] (https://github.com/pgRouting/pgrouting/issues/200)
-
An English reviewer will modify documentation for typos or grammar findings.
- Current Translations Documentation Process for next release step 1
- English Documentation Documentation Process for next release step 2
- Preparing for Next release candidate Documentation Process for next release step 3
- Translation Process
- Preparing for Next release Documentation Process for next release step 4
