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

Transform documentation #181

Closed
mmacata opened this issue Apr 28, 2021 · 0 comments · Fixed by #204
Closed

Transform documentation #181

mmacata opened this issue Apr 28, 2021 · 0 comments · Fixed by #204
Assignees
Labels
documentation related to all kinds of docs (API docs, website, ...) enhancement New feature or request

Comments

@mmacata
Copy link
Member

mmacata commented Apr 28, 2021

It would be more feasable to use markdown instead of rst. Therefore it would be good to transform the existing documentation and integrate it into CI, possibly use https://www.mkdocs.org, https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes.
While at it it would be also great to restructure existing documentation (API docs, user docs, docstring, tutorial, ...) to avoid rendundancy.

@mmacata mmacata added the enhancement New feature or request label Apr 28, 2021
@mmacata mmacata added documentation related to all kinds of docs (API docs, website, ...) website labels May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation related to all kinds of docs (API docs, website, ...) enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants