search

codezonediitj / pydatastructs

A python package for data structures and algorithms
https://pydatastructs.readthedocs.io/en/stable/
Other
201 stars 267 forks source link

Add doc in the root directory #7

Open czgdp1807 opened 5 years ago

czgdp1807 commented 5 years ago

Description of the problem

The doc folder should contain the mechanism for building the doc strings.

Example of the problem

References/Other comments

Refer, https://github.com/sympy/sympy/tree/master/doc

Subhangini commented 3 years ago

I would like to work on this issue under gssoc'21. Can you assign this issue to me?

robinsingh-ai commented 3 years ago

hey @czgdp1807 refer this i am a gssoc 21 participant and i have already worked on many documentations till now, and i think i can contribute to documentation as i am familiar with reStructuredText http://docutils.sourceforge.net/rst.html (reST) for writing documentation. Most projects use Sphinx http://www.sphinx-doc.org/en/master/ to build documentation from reST source files, and Read The Docs https://readthedocs.org/_ (RTD) for publishing them on the web. I myself have experience with Sphinx and RTD which i think will be helpful for you.

this docs are written by myself for my personal python package with the help of sphinx and ReadTheDocs website

So if you can assign me this issue i can work on this very well looking forward to your reply thanks

czgdp1807 commented 3 years ago

We do not assign issues to any contributor. When you will make a PR, just mention this issue there and that PR will get linked. You may start working on it. I would suggest to keep the build process of documentation as simple as possible (lesser the commands the better it will be).