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

Create docs #244

Open
Iapetus-11 opened this issue Jan 27, 2021 · 2 comments
Open

Create docs #244

Iapetus-11 opened this issue Jan 27, 2021 · 2 comments
Labels
Documentation Improvements or additions to documentation Enhancement New feature, request, or thing Good First Issue Good for newcomers

Comments

@Iapetus-11
Copy link
Member

Iapetus-11 commented Jan 27, 2021

  • Add docstrings to classes and functions in the sphinx style (use docblock-python or a similar plugin)
  • Create documentation on https://readthedocs.org using reStructured text
  • This should be as detailed as possible
  • Ask me on Discord if you want me to explain something or make a description / docs for it.
@Iapetus-11 Iapetus-11 added Documentation Improvements or additions to documentation Enhancement New feature, request, or thing labels Jan 27, 2021
@Sh-wayz Sh-wayz added the Good First Issue Good for newcomers label Feb 3, 2021
@Sh-wayz
Copy link
Member

Sh-wayz commented Mar 17, 2021

For people who don't know reStructured text, consider checking out pandoc for transferring your preferred format (Markdown, HTML, etc) to reStructured.

@Kingteena
Copy link

Hi, I would like to help with this issue if it is still not being worked on. However, I am new to working on a project at this scale and I do not understand how the code works, let alone how to document this. Any advice for starting?

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, request, or thing Good First Issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants