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

Improve autogenerated SDK documentation #36

Open
negz opened this issue Jan 13, 2024 · 2 comments
Open

Improve autogenerated SDK documentation #36

negz opened this issue Jan 13, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@negz
Copy link
Member

negz commented Jan 13, 2024

What problem are you facing?

We have autogenerated SDK documentation at https://crossplane.github.io/function-sdk-python/function.html, but it's not great.

Some things that could be improved:

  • There's no versioning - the generated docs always and only reflect the main branch.
  • The landing page is empty.
  • There's no documentation for the protobuf generated code.

Documentation 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.

How could this Function help solve your problem?

  • Figure out if there's some way to copy docstrings from the protobuf schema to the generated code.
  • Use a better docs tool (Sphinx, mkdocs, etc). Ideally something low maintenance.
@negz negz added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 13, 2024
@negz
Copy link
Member Author

negz commented Jan 13, 2024

FWIW I went with pdoc rather than Sphinx or mkdocs to start with because:

  • They both wanted to embed generated reference docs inside some broader docs, which I don't know that we need.
  • They both seem like 500lb gorillas. I don't want to learn and deploy a whole software project just to have documentation.

@negz
Copy link
Member Author

negz commented Jan 13, 2024

https://github.com/googleapis/protoc-docs-plugin - I see this exists, but is archived.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant