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

auto generated document format #318

Closed
egemenimre opened this issue Nov 16, 2020 · 3 comments
Closed

auto generated document format #318

egemenimre opened this issue Nov 16, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@egemenimre
Copy link

Hallo,

I see that the auto-generated document stubs for the generated classes is ReST. Are there any plans to offer this in Numpy standard or something like that? Admittedly, this is a "nice-to-have" but it would make comments easier for many people.

Btw, thanks for the excellent library, I have generated the entire set of CCSDS Navigation Data Messages (bunch of xsd files) through xsdata and it produced very clean code with clear classes.
(https://github.com/egemenimre/ccsds-ndm/tree/main/src/examples/xsdata_example/ndmxml directory)

@tefra tefra added the enhancement New feature or request label Nov 17, 2020
@egemenimre
Copy link
Author

I am no fan of adding more dependencies than is absolutely needed but maybe pyment can be interesting as a post-processor to convert the docstrings.

@tefra
Copy link
Owner

tefra commented Nov 21, 2020

It doesn't make sense to add post-processors to reformat stuff, you can do this already.

But I am interested of adding docstrings formats as a generator config option and use the jinja templates to render them accordingly.

@tefra
Copy link
Owner

tefra commented Nov 28, 2020

Introduced docstring-style config #325

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

No branches or pull requests

2 participants