Meeting June 9 & 12: Preparing Tests & Documentation

[thisisashukla]

Documentation in pgRouting

• Directories: The following are the directories involved in the documentation process

  • /doc/
  • /sql/
  • /src//test

• Process:

  • Modify /src/<myFunction>/test/doc-myFunction.test.sql and put a valid function signature and parameter values in the file
  • Delete template results in the /src/myFunction/test/doc-myFunction.result file
  • Configure the test in the test.conf file in /src/myFunction/test and add the new test to it
  • Execute algorithm-tester.pl -alg myFunction to test the algorithm of myFunction
  • Copy the generated result to the /src/myFunction/test/doc-myFunction.result file
  • Modify doc/queries/doc-myFunction.queries to doc/queries/doc-pgr_myFunction.queries
  • Execute tools/testers/algorithm-tester.pl -alg myFunction -documentation to generate new .sql and .result files
  • Modify /doc/myFunction/pgr_myFunction.rst file for proper documentation
  • Add any other required documentation rst file
  • Add new documentations to /doc/myFunction/CMakeLists.txt
  • Add new documentations to /doc/src/proposed.rst
  • Check documentation by building the project and going to /build/doc/_build/html/en/`

• References:

  • http://www.sphinx-doc.org/en/stable/