Sphinx Documentation #54
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
High Priority
Should be addressed ASAP.
🚀 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.
cc @SauravMaheshkar
The text was updated successfully, but these errors were encountered: