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

docs: improve autogenerated API docs #606

Merged
merged 9 commits into from
Oct 22, 2024
Merged

Conversation

barjin
Copy link
Contributor

@barjin barjin commented Oct 21, 2024

  • Reapplies the changes from docs: add Google-style docstring parser from SDK (renders commented function arguments)

obrazek

  • Renders the object attributes (from the class docstring)

  • Documents class inheritance properly now
    obrazek

  • Renders inherited symbols (e.g. BasicCrawler symbols in HttpCrawler)


Missing:

  • Unpack[], union types and similar -> we might need griffe to parse the code better, pydoc-markdown stops at the return type "name", doesn't parse the syntax.
  • Validation against the linked issue, see whether there's anything else missing

Related to #324

@barjin barjin added the documentation Improvements or additions to documentation. label Oct 21, 2024
@barjin barjin self-assigned this Oct 21, 2024
@github-actions github-actions bot added this to the 101st sprint - Tooling team milestone Oct 21, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Oct 21, 2024
@barjin barjin marked this pull request as ready for review October 22, 2024 09:11
Copy link
Collaborator

@vdusek vdusek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to render it locally. Great progress.

@barjin barjin merged commit 01f0746 into master Oct 22, 2024
20 checks passed
@barjin barjin deleted the docs/documentation-revamp branch October 22, 2024 09:41
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. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants