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

Sphinx Documentation #54

Open
2 of 7 tasks
oke-aditya opened this issue Nov 28, 2020 · 0 comments
Open
2 of 7 tasks

Sphinx Documentation #54

oke-aditya opened this issue Nov 28, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request High Priority Should be addressed ASAP.

Comments

@oke-aditya
Copy link
Owner

oke-aditya commented Nov 28, 2020

🚀 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

@oke-aditya oke-aditya added the enhancement New feature or request label Nov 28, 2020
@oke-aditya oke-aditya added documentation Improvements or additions to documentation High Priority Should be addressed ASAP. labels Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request High Priority Should be addressed ASAP.
Projects
None yet
Development

No branches or pull requests

1 participant