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

API Docs #51

Open
Cleptomania opened this issue Jan 9, 2022 · 1 comment
Open

API Docs #51

Cleptomania opened this issue Jan 9, 2022 · 1 comment
Labels
docs enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@Cleptomania
Copy link
Member

Docs are currently being re-worked and using mkdocs. The autogenerated API docs are also being re-done as part of this. Currently the docstrings themselves are about half way to being done I’d say.

The setup within mkdocs definitely still needs some more work.

Still need to do some experimentation and testing out different methods for this to see what works best.

@Cleptomania Cleptomania added the enhancement New feature or request label Jan 9, 2022
@Cleptomania Cleptomania added this to the Version 2.1 milestone Jan 9, 2022
@Cleptomania Cleptomania removed this from the Version 2.1 milestone Aug 13, 2022
@Cleptomania
Copy link
Member Author

We are no longer using mkdocs, and instead using Sphinx. For the most part, API Docs are complete, but they could use a look through and seeing what might still be missing(some things may have docstrings and just not being included in the docs build). I don't think it is worth having API docs for the parsers directly as those are only really intended for internal use .

@Cleptomania Cleptomania added the good first issue Good for newcomers label Apr 13, 2023
@Cleptomania Cleptomania added this to the Version 2.3 milestone Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant