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.

Sign up for GitHub

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

Jump to bottom

Better API documentation #2

Open
andlaus opened this issue Nov 12, 2021 · 0 comments
Open

Better API documentation #2

andlaus opened this issue Nov 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first contribution Good for newcomers help wanted Extra attention is needed nice to have Things which improve the quality of life but are not a matter of life and death.

Comments

@andlaus
Copy link
Collaborator

andlaus commented Nov 12, 2021 •
edited
Loading

The API documentation is generated from the python docstrings and it can be generated and inspected via

cd $ODXTOOLS_SRC_DIR/doc
make html
firefox _build/html/index.html

It IMO already looks decent, but it is sorely lacking in completeness and does not feature any "tutorial style" introductions. this should be changed in the medium to long term.

Andreas Lauser <andreas.lauser@mercedes-benz.com>, on behalf of MBition GmbH.
Provider Information
@andlaus andlaus added documentation Improvements or additions to documentation good first contribution Good for newcomers help wanted Extra attention is needed nice to have Things which improve the quality of life but are not a matter of life and death. labels Nov 12, 2021
@andlaus andlaus closed this as completed in 4072419 Oct 9, 2023
@andlaus andlaus reopened this Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first contribution Good for newcomers help wanted Extra attention is needed nice to have Things which improve the quality of life but are not a matter of life and death.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andlaus