OSGeo
pgRouting: workshop page with wikipedia example
Before you do this task do:
- pgRouting: Workshop first task [0]
- Fork and clone https://github.com/pgRouting/workshop
- Create a branch that matches your github name
The example of Dijkstra Algorithm on wikipedia can be solved using the following code:
https://github.com/pgRouting/pgrouting/blob/master/src/dijkstra/demo/wiki_demo.sql
The task is to create a file "wiki_example.rst" for the pgRouting workshop that includes the contents, a link to wikipedia and the license.
Steps
- Make sure you are working on the branch created on pgRouting: Workshop first task [0]
- Create the new file named on the root of the repository
- copy/paste an organize. Use sphinx to format.
- Add the new file: git add
- Commit your work using the task tittle as comment: git commit -m ' '
- Push your work: git push
- Make a Pull Request to https://github.com/pgRouting/workshop
References:
- Sphinx adding code documentation.
- Sphinx adding images documentation.
- Example Sphinx page:
- This "documentation code": https://raw.githubusercontent.com/pgRouting/workshop/master/docs/source/chapters/shortest_path.rst
- Generates this page: http://workshop.pgrouting.org/2.4.11/en/chapters/shortest_path.html
Questions?
- IRC osgeo-gsoc channel on freenode
- https://gitter.im/pgRouting/pgrouting
Task tags
Students who completed this task
Jerry Huang, Jason Wong-1