clear explanation of #121

[hisandeepangara]

I'm assigned the issue #121. I would like to work on it. Could you please explain clearly what changes to be done ?

[davidbuniat]

@sandeep3136 copying the info here!

Here is more information about the task, but this requires slightly more exploration from your end which is exciting!

1. First of all need to research how other open-source tools build their documentation. We are using Sphinx for building the our docs. Then, we use service https://readthedocs.org/ that directly hooks with our GitHub master branch and pushes changes to docs.
2. Then need to look into other open-source repos such as PyTorch or Ray and see how they set up their documentation settings. Questions include answering
   • What kind of style do they use?
   • What are the plugins added to documentation to make it more convenient?
3. Then, make a creative proposal on using the specific style and potentially any additional plugins for making more convenient for developers to easily use docs. (make sure that readmethedocs support all added features o/w feel free to propose a custom deployment)
4. Finally implement. This should take the least amount of effort since it's a config change. Might require a couple of forth-and-back with PRs to make sure docs are successfully deployed.

Notes

• Bonus karma for making it a team effort
• Feel free to use this thread for discussions or questions you might have.

[mikayelh]

Hey @sandeep3136 , are you still interested in contributed to this issue? Let me know, we're happy to help.