-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
High PriorityShould be addressed ASAP.Should be addressed ASAP.documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
🚀 Feature
-
Sphinx Documentation akin to PyTorch or PyTorch Lightning will be nice.
-
Plan of Action
-
Add Sphinx Docs, Makefiles, conf.py etc.
-
Build docs locally.
-
Add CI to check docs on PR.
-
CD to deploy docs over GH Pages on push to master.
-
Fixup all the warning in docs.
-
Move examples to docs.
-
Add docs section to
contributing.md
file. Show steps to build docs locally.
I hope we can use PyTorch Lightning / PyTorch theme, it will be nice to keep consistency.
hassiahk and zhiqwang
Metadata
Metadata
Assignees
Labels
High PriorityShould be addressed ASAP.Should be addressed ASAP.documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request