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 API documentation #559

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve API documentation #559

wants to merge 4 commits into from

Conversation

ponyisi
Copy link
Collaborator

@ponyisi ponyisi commented Jan 23, 2025

Improve the presentation of the servicex API documentation:

  • move the top-level module into its own page
  • move the internals to their own file
  • keep top-level servicex.app and servicex.func_adl indices
  • use enum-tools to make enums look nicer

@matthewfeickert
Copy link
Member

@ponyisi sorry that I didn't get to this today. I'll try to get a local review done on Friday before late afternoon.

@BenGalewsky
Copy link
Contributor

Is there any way to make the DeliveryEnum type in the General constructor argument documentation clickable?
i.e.

Delivery – (DeliveryEnum) Specifies the delivery method for the output files.

@ponyisi
Copy link
Collaborator Author

ponyisi commented Jan 24, 2025

@BenGalewsky I've tried a new variant where the "constructor" isn't documented at all for the Pydantic classes (this is the default, we only introduced that block because of trying to make command-line docstrings work nicely).

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.

3 participants