Meeting June 2: New Documentation Structure Discussion

[thisisashukla]

New documentation structure discussion

https://github.com/cvvergara/pgrouting/blob/experiment/transifex/configuration.conf that "experiment" is going well. So, the CMakeLists will read from that file. So for example, topology | N | Y | Y does not have C code. deprecated | N | Y | N deprecated no C code and no documentation. So, you will need to add a line with the name of your directory, and they have SQL and C code dijkstraTRSP | Y | Y | N because it does not have "valid" documentation (yet) dijkstraTRSP | Y | Y | Y when it has documentation (users) https://github.com/cvvergara/pgrouting/tree/experiment/transifex/src/allpairs you can see all directories under src like allpairs do not have "doc" as a subdirectory https://github.com/cvvergara/pgrouting/tree/experiment/transifex/doc All of those diectories I moved them under doc https://github.com/cvvergara/pgrouting/tree/experiment/transifex/doc/allpairs now there is a CMakeLists there https://github.com/cvvergara/pgrouting/blob/experiment/transifex/doc/allpairs/CMakeLists.txt and there, you indicate which files to consider for the build https://github.com/cvvergara/pgrouting/tree/experiment/transifex/doc/queries that is special directory the files are generated when using the "algorithm tester" with the -documentation flag. So, once @ccvergara merges into develop,

• [ ] we have to update your form, and move some files around the documentation files the query files and how have a line in the configuration (might as well put the line with a comment, and we just only uncomment)

The tests, still where they are

[thisisashukla]

Pointers on Documentation

• http://www.sphinx-doc.org/en/stable/index.html
  • can cosider that is a kind of programming language for documentation
• lets go to some documentation "code" and how it looks in reality
  • Code - https://github.com/pgRouting/pgrouting/blob/develop/src/allpairs/doc/pgr_floydWarshall.rst
  • Reality - http://docs.pgrouting.org/dev/en/pgr_floydWarshall.html#pgr-floydwarshall

[thisisashukla]

Compiler is your friend

Imagine that I change the name of General_path_element_t basically all the code uses that instead of finding it it by hand, reading all the files. I let the compiler look for the places I need to change. It will complain and the I go edit where the compiler complains

[thisisashukla]

Pointers on Tests

Computer does what you indicate it to do currently the configuration file of tests is in the test.conf if a name is changed, then you have to indicate in the configuration what changed for the pgtap files anything inside the pgtap directory will be tested or nothing if you comment out the line in the file: https://github.com/vidhan13j07/pgrouting/blob/gsoc/rewritetrsp/tools/testers/pg_prove_tests.sh So the configuration for the pgtap tests is in pg_prove_tests.sh file so pgtaps configuration is an ALL or NOTHING configuration and the other "tests" are configured in the test.conf because the pgtap are ALL or NOTHING I found it better to use the tests to make designs of the soon to be pgtap tests so, you have now a file where you will be designing tests and then you will make more pgtap tests