René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Improve autogenerated SDK documentation","articleBody":"\u003c!--\r\nThank you for helping to improve Crossplane!\r\n\r\nPlease be sure to search for open issues before raising a new one. We use issues\r\nfor bug reports and feature requests. Please find us at https://slack.crossplane.io\r\nfor questions, support, and discussion.\r\n--\u003e\r\n\r\n### What problem are you facing?\r\n\u003c!--\r\nPlease tell us a little about your use case - it's okay if it's hypothetical!\r\nLeading with this context helps frame the feature request so we can ensure we\r\nimplement it sensibly.\r\n---\u003e\r\n\r\nWe have autogenerated SDK documentation at https://crossplane.github.io/function-sdk-python/function.html, but it's not great.\r\n\r\nSome things that could be improved:\r\n\r\n* There's no versioning - the generated docs always and only reflect the `main` branch.\r\n* The landing page is empty.\r\n* There's no documentation for the protobuf generated code.\r\n\r\nDocumentation for the protobuf generated code seems like it would be very valuable, since there's not much else to this SDK apart from a few utilities. Unfortunately the code itself doesn't seem to have docstrings, despite the protobuf messages it's generated from having them.\r\n\r\n### How could this Function help solve your problem?\r\n\u003c!--\r\nLet us know how you think this Function could help with your use case. \r\n--\u003e\r\n\r\n* Figure out if there's some way to copy docstrings from the protobuf schema to the generated code.\r\n* Use a better docs tool (Sphinx, mkdocs, etc). Ideally something low maintenance.","author":{"url":"https://github.com/negz","@type":"Person","name":"negz"},"datePublished":"2024-01-13T00:11:44.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/36/function-sdk-python/issues/36"}