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.

Sign up for GitHub

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

Jump to bottom

Docs #1

Open
giuliano-macedo opened this issue Dec 7, 2020 · 1 comment
Open

Docs #1

giuliano-macedo opened this issue Dec 7, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@giuliano-macedo
Copy link
Owner

Mostly of the code have google styled docstrings, however i haven't setup any documentation program like sphynx.
@giuliano-macedo giuliano-macedo added help wanted Extra attention is needed documentation Improvements or additions to documentation labels Dec 7, 2020
@adhistac
Copy link

adhistac commented Jan 7, 2021

To install sphinx enter the command pip install sphinx in the terminal.
To get started with sphinx, first, build a folder and enter sphinx-quickstart in the terminal, fill in the details, you are good to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@giuliano-macedo @adhistac