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

Add API documentation #84

Open
thesadru opened this issue Nov 6, 2022 · 0 comments
Open

Add API documentation #84

thesadru opened this issue Nov 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@thesadru
Copy link
Owner

thesadru commented Nov 6, 2022

Possibilities:

  • mkdocs material for guide and pdoc for API (ugly)
  • mkdocs material for guide and sphinx for API (confusing)
  • sphinx for guide and API (limiting)
@thesadru thesadru added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 6, 2022
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 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thesadru