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

Structure of documentation #31

Open
5 of 7 tasks
duylamvo opened this issue May 19, 2021 · 1 comment
Open
5 of 7 tasks

Structure of documentation #31

duylamvo opened this issue May 19, 2021 · 1 comment
Assignees
@duylamvo
Labels
documentation Improvements or additions to documentation

Comments

@duylamvo
Copy link
Collaborator

duylamvo commented May 19, 2021 •
edited
Loading

  • Initial setup for sphinx
  • Installation
  • Quick Start Tutorial
  • Segmentation Tutorial
  • Evaluation Tutorial
  • Rewrite docstring in Modules. Apply restructedText in docstring
  • Prepare hooks for publishing to readthedocs.io

Note:

  • do not delete branch gh-pages -> this branch is reserved for building docs generated by sphinx
@duylamvo duylamvo self-assigned this May 19, 2021
@duylamvo duylamvo added the documentation Improvements or additions to documentation label May 19, 2021
@duylamvo
Copy link
Collaborator Author

added support to convert notebook -> rst.
Feel free to write any tutorial or notebook under docs/source/usage/your-tutorial.ipynb and add it into docs/source/index.rst under toctree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@duylamvo duylamvo

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@duylamvo