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.

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

Use gdnative-doc for documentation #107

Merged
merged 6 commits into from
Mar 12, 2021

Conversation

arnaudgolfouse
Copy link
Contributor

This adds a dependency on gdnative-doc to generate the documentation from the Rust code.

The actual content of the documentation (previously in addons/dijkstra-map/DOCUMENTATION.md, now in addons/dijkstra-map/doc/index.md and addons/dijkstra-map/doc/DijkstraMap.md) was slightly changed:

  • Methods are no longer organized in sections (previously Methods for constructing and modifying the graph-Methods for recalculating the DijkstraMap-etc...). To counter this, I tried to add more class-level explanation.
  • There are now links to Godot's own documentation !
  • A LOT of examples were added: not only do I hope this will be beneficial to the docs, they also automatically get translated into Gut tests

Overall I think it looks very good, and I hope this will make for good and maintainable documentation 😁

P.S.: Maybe this will require some explanation so that contributors know they need to modify lib.rs to affect the documentation...

@astrale-sharp astrale-sharp merged commit 4f1677c into MatejSloboda:master Mar 12, 2021
@arnaudgolfouse arnaudgolfouse deleted the use-gdnative-doc branch March 28, 2021 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants