Add documentation in readthedocs

[OmkarPathak]

Add the documentation about implementation and features of this library

[LittleSodium]

Hey Omkar! I would like to work on this issue. Could you guide me with the specifics?

[OmkarPathak]

@LittleSodium thanks for your interest. You can refer this documentation: https://pygorithm.readthedocs.io/en/latest/

Basically we need to document our classes and functions and their usage so that users will be able to work with the library more easily.

[RodolfoFerro]

I can work on this.

I will just wait for @LittleSodium to confirm if grabbing this issue. If not, I can take it. ✌️

[LittleSodium]

@OmkarPathak got it! Is it fine if I email you for further questions and queries? @RodolfoFerro I'll be working on this one :)

[OmkarPathak]

@LittleSodium sure you can email me anytime 😄

[OmkarPathak]

I can work on this.

I will just wait for @LittleSodium to confirm if grabbing this issue. If not, I can take it. ✌️

You can simultaneously work on the same

[RodolfoFerro]

No problem, good luck @LittleSodium! ✨ Btw, if you're planning to use MkDocs, I can help. 👍

Thanks @OmkarPathak !

[LittleSodium]

@RodolfoFerro I'm super new to open source and this might just be my first ever actual contribution so any help would be appreciated!

[RodolfoFerro]

@LittleSodium No problem, first fork this repo into your GitHub user. Then I would install the requirements and try to test everything.

Now the contribution part comes. I would:

• Install MkDocs
• Create a new docs project
• Build documentation
• Create a readthedocs account
• Build documentation from repo in readthedocs
• Done!

[OmkarPathak]

@RodolfoFerro we can also host Mkdocs on GitHub pages. We can also look into this option