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

Documentation/rework #69

Merged
merged 30 commits into from
Feb 8, 2021
Merged

Documentation/rework #69

merged 30 commits into from
Feb 8, 2021

Conversation

da-h
Copy link
Owner

@da-h da-h commented Feb 8, 2021

This MR adds a mostly complete API to the documentation.

For this purpose, a script was written that writes the doc-strings from the code into separate files.
Some of these are then linked or used from the main documentation.

@da-h da-h requested a review from sbrodehl February 8, 2021 19:27
@da-h da-h force-pushed the documentation/rework branch from d654845 to 84ed408 Compare February 8, 2021 19:38
@da-h da-h force-pushed the documentation/rework branch 3 times, most recently from b179bc5 to 2df7c66 Compare February 8, 2021 19:49
Copy link
Collaborator

@sbrodehl sbrodehl left a comment

Choose a reason for hiding this comment

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

One simple question: why not use tools like pdoc to parse the API?

@da-h da-h merged commit 35fcb56 into v2-dev Feb 8, 2021
@da-h da-h deleted the documentation/rework branch February 8, 2021 21:42
@da-h da-h mentioned this pull request Jul 26, 2021
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.

2 participants