Adding Dijkstra's algo specific doc#8286
Conversation
rossbar
left a comment
There was a problem hiding this comment.
In principal I think this is a good idea - Dijkstra's algorithm and shortest-path in general are very popular topics.
Alright, addressed your comment and marked it as ready for review! |
|
What do folks think about this one? |
e1d3136 to
12cae7b
Compare
Co-authored-by: Dan Schult <dschult@colgate.edu>
|
Pushed a second revision with comments addressed and some rework! |
dschult
left a comment
There was a problem hiding this comment.
This looks good! Thanks @amcandio !
I believe we've got sphinx set up to allow, e.g. where each edge $(u, v) \in E$ has a rather than using the :math: prefix and single-ticks. I haven't tried both to see what the difference is. But if they are actually the same, the :math:. I approve this change either way.
I think this is ready to go in. :)
|
Ah didn't realize that! I simplified and also fixed some spacing that was causing some odd rendering in Sphinx |
Unfortunately dollar math struggles with vertical bars, which sphinx interprets as substitution characters. The explicit math role doesn't have this problem.
rossbar
left a comment
There was a problem hiding this comment.
Thanks @amcandio , LGTM!
I took the liberty of pushing up a few rst/sphinx-y tweaks, mostly to handle doc build warnings and use built-in roles where possible. One thing I did directly undoes one of @dschult 's suggestions: I had to switch the $ math back to the :math: role in the complexity section. The reason for doing so is that the dollar math extension we use hooks into the doc build after the docstring has already been parsed by sphinx, and sphinx treats vertical bars (i.e. |) as characters for substitution. Anyways - the details are arcane, but in general I agree with @dschult that $ math reads better, but for this one corner case where | characters are involved!
|
Thank you so much for all the help and fixes! I really like the end result 🙂 |
networkx/networkx#8286, introduced in networkx 3.6, changed the documentation URLs. networkx/networkx#8373, introduced in networkx 3.6.1, reverted this change. Require networkx 3.6.1 to get the reversion.
…x for networkx 3.6.1 compat (#218) networkx/networkx#8286, introduced in networkx 3.6, changed the documentation URLs. networkx/networkx#8373, introduced in networkx 3.6.1, reverted this change. Require networkx 3.6.1 to get the reversion. Authors: - Kyle Edwards (https://github.com/KyleFromNVIDIA) - Rick Ratzel (https://github.com/rlratzel) Approvers: - Gil Forsyth (https://github.com/gforsyth) - Bradley Dice (https://github.com/bdice) - Rick Ratzel (https://github.com/rlratzel) URL: #218
Dijkstra’s algorithm was only mentioned within the general shortest paths documentation. This PR provides a more detailed reference page for Dijkstra's under
doc/reference/algorithms/. We update the shortest path documentation section to refer to link to this new page so it can be discovered.