Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use parsed-literal instead of code-block on signatures #2244

Closed
cvvergara opened this issue Feb 1, 2022 · 16 comments
Closed

Use parsed-literal instead of code-block on signatures #2244

cvvergara opened this issue Feb 1, 2022 · 16 comments
Assignees
@robe2
Labels
Documentation Enhancement good first issue
Milestone
Release 3.4.0

Comments

@cvvergara
Copy link
Member

cvvergara commented Feb 1, 2022 •
edited
Loading

Using code-block does not allow links to sections on the documentation page

image

Using parsed-literal allows links, specially useful for the inner queries

image

  • doc/allpairs/allpairs-family.rst
  • doc/allpairs/pgr_floydWarshall.rst
  • doc/allpairs/pgr_johnson.rst
  • doc/alpha_shape/pgr_alphaShape.rst
  • doc/astar/aStar-family.rst
  • doc/astar/pgr_aStar.rst
  • doc/astar/pgr_aStarCost.rst
  • doc/astar/pgr_aStarCostMatrix.rst
  • doc/bdAstar/bdAstar-family.rst
  • doc/bdAstar/pgr_bdAstar.rst
  • doc/bdAstar/pgr_bdAstarCost.rst
  • doc/bdAstar/pgr_bdAstarCostMatrix.rst
  • doc/bdDijkstra/bdDijkstra-family.rst
  • doc/bdDijkstra/pgr_bdDijkstra.rst
  • doc/bdDijkstra/pgr_bdDijkstraCost.rst
  • doc/bdDijkstra/pgr_bdDijkstraCostMatrix.rst
  • doc/bellman_ford/pgr_bellmanFord.rst
  • doc/bellman_ford/pgr_edwardMoore.rst
  • doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst
  • doc/breadthFirstSearch/pgr_breadthFirstSearch.rst
  • doc/chinese/chinesePostmanProblem-family.rst
  • doc/chinese/pgr_chinesePostman.rst
  • doc/chinese/pgr_chinesePostmanCost.rst
  • doc/coloring/coloring-family.rst
  • doc/coloring/pgr_bipartite.rst
  • doc/coloring/pgr_edgeColoring.rst
  • doc/coloring/pgr_sequentialVertexColoring.rst
  • doc/components/components-family.rst
  • doc/components/pgr_articulationPoints.rst
  • doc/components/pgr_biconnectedComponents.rst
  • doc/components/pgr_bridges.rst
  • doc/components/pgr_connectedComponents.rst
  • doc/components/pgr_makeConnected.rst
  • doc/components/pgr_strongComponents.rst
  • doc/contraction/contraction-family.rst
  • doc/contraction/pgr_contraction.rst
  • doc/dagShortestPath/pgr_dagShortestPath.rst
  • doc/dijkstra/dijkstra-family.rst
  • doc/dijkstra/pgr_dijkstra.rst
  • doc/dijkstra/pgr_dijkstraCost.rst
  • doc/dijkstra/pgr_dijkstraCostMatrix.rst
  • doc/dijkstra/pgr_dijkstraNear.rst
  • doc/dijkstra/pgr_dijkstraNearCost.rst
  • doc/dijkstra/pgr_dijkstraVia.rst
  • doc/dominator/pgr_lengauerTarjanDominatorTree.rst
  • doc/driving_distance/drivingDistance-category.rst
  • doc/driving_distance/pgr_drivingDistance.rst
  • doc/ksp/KSP-category.rst
  • doc/ksp/pgr_KSP.rst
  • doc/lineGraph/pgr_lineGraph.rst
  • doc/lineGraph/pgr_lineGraphFull.rst
  • doc/lineGraph/transformation-family.rst
  • doc/max_flow/flow-family.rst
  • doc/max_flow/pgr_boykovKolmogorov.rst
  • doc/max_flow/pgr_edgeDisjointPaths.rst
  • doc/max_flow/pgr_edmondsKarp.rst
  • doc/max_flow/pgr_maxCardinalityMatch.rst
  • doc/max_flow/pgr_maxFlow.rst
  • doc/max_flow/pgr_maxFlowMinCost.rst
  • doc/max_flow/pgr_maxFlowMinCost_Cost.rst
  • doc/max_flow/pgr_pushRelabel.rst
  • doc/mincut/pgr_stoerWagner.rst
  • doc/pickDeliver/VRP-category.rst
  • doc/pickDeliver/pgr_pickDeliver.rst
  • doc/pickDeliver/pgr_pickDeliverEuclidean.rst
  • doc/planar/pgr_isPlanar.rst
  • doc/spanningTree/kruskal-family.rst
  • doc/spanningTree/pgr_kruskal.rst
  • doc/spanningTree/pgr_kruskalBFS.rst
  • doc/spanningTree/pgr_kruskalDD.rst
  • doc/spanningTree/pgr_kruskalDFS.rst
  • doc/spanningTree/pgr_prim.rst
  • doc/spanningTree/pgr_primBFS.rst
  • doc/spanningTree/pgr_primDD.rst
  • doc/spanningTree/pgr_primDFS.rst
  • doc/spanningTree/pgr_randomSpanTree.rst
  • doc/spanningTree/prim-family.rst
  • doc/spanningTree/spanningTree-family.rst
  • doc/src/cost-category.rst
  • doc/src/costMatrix-category.rst
  • doc/src/experimental.rst
  • doc/src/index.rst
  • doc/src/pgRouting-concepts.rst
  • doc/src/pgRouting-installation.rst
  • doc/src/pgRouting-introduction.rst
  • doc/src/proposed.rst
  • doc/src/release_notes.rst
  • doc/src/routingFunctions.rst
  • doc/src/sampledata.rst
  • doc/src/support.rst
  • doc/topologicalSort/pgr_topologicalSort.rst
  • doc/topology/pgr_analyzeOneWay.rst
  • doc/topology/pgr_createTopology.rst
  • doc/topology/pgr_createVerticesTable.rst
  • doc/topology/pgr_analyzeGraph.rst
  • doc/topology/pgr_extractVertices.rst
  • doc/topology/pgr_nodeNetwork.rst
  • doc/topology/topology-functions.rst
  • doc/transitiveClosure/pgr_transitiveClosure.rst
  • doc/traversal/pgr_depthFirstSearch.rst
  • doc/traversal/traversal-family.rst
  • doc/trsp/TRSP-family.rst
  • doc/trsp/pgr_trsp.rst
  • doc/trsp/pgr_trsp_withPoints.rst
  • doc/trsp/pgr_trspVia.rst
  • doc/trsp/pgr_trspVia_withPoints.rst
  • doc/trsp/pgr_trspviaedges.rst
  • doc/trsp/pgr_trspviavertices.rst
  • doc/trsp/pgr_turnRestrictedPath.rst
  • doc/tsp/TSP-family.rst
  • doc/tsp/pgr_TSP.rst
  • doc/tsp/pgr_TSPeuclidean.rst
  • doc/version/pgr_full_version.rst
  • doc/version/pgr_version.rst
  • doc/vrp_basic/pgr_vrpOneDepot.rst
  • doc/withPoints/pgr_withPoints.rst
  • doc/withPoints/pgr_withPointsCost.rst
  • doc/withPoints/pgr_withPointsCostMatrix.rst
  • doc/withPoints/pgr_withPointsDD.rst
  • doc/withPoints/pgr_withPointsKSP.rst
  • doc/withPoints/pgr_withPointsVia.rst
  • doc/withPoints/withPoints-family.rst
@cvvergara cvvergara added this to the Release 3.4.0 milestone Feb 1, 2022
@cvvergara
Copy link
Member Author

Please write in a comment your intended changes.
Example:
I am working on these:

  • doc/trsp/pgr_trsp.rst
  • doc/trsp/TRSP-family.rst
  • doc/trsp/pgr_turnRestrictedPath.rst

@RishiKumarRay
Copy link

do we have to change all references in a file (whichever we are working ) to parsed-literal?

@cvvergara
Copy link
Member Author

This files are not used and will be deleted.

  • doc/trsp/pgr_trspviaedges.rst
  • doc/trsp/pgr_trspviavertices.rst

@cvvergara
Copy link
Member Author

For example: This was the change needed on pgr_trsp
https://github.com/pgRouting/pgrouting/pull/2242/files#diff-5bc2516137a61edf79611e1f888d29e2fa0d5bfb07b5e4b3ea77033c88ddc941R96

@cvvergara
Copy link
Member Author

If needed, to make it standard (and shorter) using SQL

This is a link to the title

`Edges SQL`_

This is the title

Edges SQL
---------------------------------------------------------

They should match.
If needed change Query to SQL

@robe2 robe2 self-assigned this Feb 10, 2022
@robe2
Copy link
Member

robe2 commented Feb 10, 2022

This looks much clearer to me now what the SQL args are.

@cvvergara cvvergara mentioned this issue Feb 15, 2022
Merged
@cvvergara cvvergara mentioned this issue Mar 28, 2022
Merged
@cvvergara
Copy link
Member Author

Will be using bold font on unnamed parameters

This was referenced Mar 30, 2022
Merged
Merged
@cvvergara cvvergara mentioned this issue Apr 21, 2022
Merged
@nitishchauhan0022
Copy link
Member

Hello Everyone, I also want to work on this issue. I am starting with experimental functions

  • doc/bellman_ford/pgr_bellmanFord.rst
  • doc/bellman_ford/pgr_edwardMoore.rst

This was referenced Apr 26, 2022
Merged
Merged
@cvvergara
Copy link
Member Author

@nitishchauhan0022 Thanks

@cvvergara cvvergara mentioned this issue Apr 28, 2022
Merged
@cvvergara
Copy link
Member Author

I will be doing maxflow functions

@nitishchauhan0022
Copy link
Member

I will work on

  • doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst
  • doc/breadthFirstSearch/pgr_breadthFirstSearch.rst

@sbdtu5498
Copy link
Member

@cvvergara @nitishchauhan0022 I will be working on the following experimental functions:-

  • doc/coloring/coloring-family.rst
  • doc/coloring/pgr_bipartite.rst
  • doc/coloring/pgr_edgeColoring.rst
  • doc/coloring/pgr_sequentialVertexColoring.rst

@cvvergara cvvergara mentioned this issue May 2, 2022
Merged
@sbdtu5498 sbdtu5498 mentioned this issue May 2, 2022
Merged
@nitishchauhan0022 nitishchauhan0022 mentioned this issue May 3, 2022
Merged
This was referenced May 3, 2022
Merged
Merged
@cvvergara cvvergara mentioned this issue May 5, 2022
Merged
@nitishchauhan0022
Copy link
Member

I am working on

  • doc/chinese/chinesePostmanProblem-family.rst
  • doc/chinese/pgr_chinesePostman.rst
  • doc/chinese/pgr_chinesePostmanCost.rst

This was referenced May 5, 2022
Merged
Merged
@nitishchauhan0022 nitishchauhan0022 mentioned this issue May 7, 2022
Merged
@cvvergara
Copy link
Member Author

I am working on topology

@cvvergara cvvergara mentioned this issue May 11, 2022
Merged
@cvvergara
Copy link
Member Author

I am also working on ksp

@cvvergara
Copy link
Member Author

ksp is finished PR is pending

@cvvergara cvvergara mentioned this issue Jun 2, 2022
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@robe2 robe2

Labels
Documentation Enhancement good first issue
Projects
None yet
Milestone
Release 3.4.0
Development

No branches or pull requests
5 participants
@robe2 @cvvergara @nitishchauhan0022 @RishiKumarRay @sbdtu5498