search

sbromberger / LightGraphs.jl

An optimized graphs package for the Julia programming language
Other
670 stars 184 forks source link

Documentation broken for generators #1520

Closed mlhetland closed 3 years ago

mlhetland commented 3 years ago

The various graph generators have copious docstrings, and there is a section about them in the manual, but for some reason, it seems that there's a bug in the setup, so that the "Graph Generators" section only includes things like add_edge! etc. (which don't belong there).

Not sure how to fix, but I'd guess it should be straightforward?

sbromberger commented 3 years ago

Closing because I think we've fixed the bug that prevented documentation from building correctly.

Ref: https://juliagraphs.org/LightGraphs.jl/latest/generators/ and #1527

mlhetland commented 3 years ago

Looks good! Though I see now that the new Watts–Strogatz docstring has some Markdown issues (with a couple of minuses turning into bullet lists, and a headline ending up in a code block).

mlhetland commented 3 years ago

Created a quick PR (#1533) for the docstring errors.