Skip to content

Sphinx Documentation #54

@oke-aditya

Description

@oke-aditya

🚀 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    High PriorityShould be addressed ASAP.documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions