Closed marchuffnagle closed 11 months ago
As presented, linking to each class does make the documentation much easier to use.
I've really been meaning to integrate an auto-doc library that can format the class docs better than my basic attempt to do the same.
I've really been meaning to integrate an auto-doc library that can format the class docs better than my basic attempt to do the same.
I agree, this is the way to go rather than manually updating the docs. In my experience, there's a 100% chance the docs won't match the code if it's done by hand. I'll take a stab at a PoC using something like pdoc and issue another draft PR.
Description
The docs show the avwx-specific types that are used as arguments or return values, but only as text. It would be easier to navigate the docs if the types were updated to be links instead. I've updated the
airsigmet.md
file to show what I have in mind, and have confirmed that the links work as expected when run throughmkdocs
. @flyinactor91 , what are your thoughts on a change like this? I'm happy to update the other md files and issue a full PR if this is a change you'd be open to.Checklist
CHANGELOG.md
OR changes are insignificant