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

Generate API documentation #5

Open
sbliven opened this issue Apr 11, 2023 · 1 comment
Open

Generate API documentation #5

sbliven opened this issue Apr 11, 2023 · 1 comment

Comments

@sbliven
Copy link

sbliven commented Apr 11, 2023

Is the generated API documented anywhere? This would be useful for documenting particular version (if https://developer.mozilla.org changes), as well as documenting the expected parameters.

Guessing valid parameters from the SVG documentation is not always straightforward (for instance Ellipse accepts x and y in addition to the svg-style cx and cy). It also wasn't clear to me when starting out whether all parameters expect strings or if python types would work too (eg if Polygon would accept a list of points like [(0,0), (0,1),...]

@stevej2608
Copy link
Owner

The SVG package is generated using the same tooling as that used to create the Dash core and html packages. The API in each case is defined by the function docstrings. I use VSCODE and python intellisense works well.

There must be python cli tools that can read the package docstrings and spit them out in some other format, html, read the docs, or whatever.

The Dash tooling doesn't currently emit typings, it would be great if it did.

Cheers, Steve

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

No branches or pull requests

2 participants