Skip to content
This repository has been archived by the owner on Jun 16, 2020. It is now read-only.

API documentation #26

Open
lquenti opened this issue Aug 10, 2019 · 2 comments
Open

API documentation #26

lquenti opened this issue Aug 10, 2019 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone
Create good Docum...

Comments

@lquenti
Copy link
Member

lquenti commented Aug 10, 2019

Is your feature request related to a problem? Please describe.
It would be a good idea to create formal docs that people can use the library.

Describe the solution you'd like
Some way to have the javadocs and maybe a few examples hosted somewhere.

Describe alternatives you've considered
Maybe something arount Sphinx? Because I'd really love to have elaborate examples instead of the old javadocs API only stuff

Additional context
Should only be done once we are at a deployable version, which is completely commented and tested.
@lquenti lquenti added the documentation Improvements or additions to documentation label Aug 10, 2019
@lquenti
Copy link
Member Author

lquenti commented Aug 10, 2019

We should also add that to the readme

@lquenti
Copy link
Member Author

lquenti commented Aug 10, 2019

Kind of related to #8

@lquenti lquenti added this to the Create good Documentation milestone Aug 10, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Create good Documentation
Development

No branches or pull requests
1 participant
@lquenti