Skip to content

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

Copy link
Collaborator

@gordonwatts gordonwatts left a comment

Choose a reason for hiding this comment

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

Very hard to see what changes are actually happening by looking at the source code, but nothing stood out.

@ponyisi ponyisi merged commit 7254ae3 into master Feb 4, 2025
35 checks passed
@ponyisi ponyisi deleted the autodoc-improvement branch February 4, 2025 15:12
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.

5 participants