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

Documentations? #47

Open
andreped opened this issue Jun 2, 2023 · 1 comment
Open

Documentations? #47

andreped opened this issue Jun 2, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@andreped
Copy link
Collaborator

andreped commented Jun 2, 2023

Is your feature request related to a problem? Please describe.
I believe a lot of users would benefit of clearer documentations on which methods actually exist and how to use them. This is not so clear from the README, and there are numerous nuances in applications which we do not cover, and may result in end users having a hard time getting this to work.

Describe the solution you'd like
For a different python package I am developing, I created documentations and hosted it for free on ReadTheDocs. This is extremely easy to do. And I setup all the logic necessary for this to work.

However, in order for me to setup, test, and deploy the documentations, it would be nice if I had suitable permissions.
Alternatively, @carloalbertobarbano or someone would create a user at ReadTheDocs (can link to GitHub account), and link this repo to a ReadTheDocs project. That way deployment of docs should work seemlessly.

I can start making the PR now. I will add a docs/ directory the repo where all relevant information should lie. I will also use autodocs to build the API documentation, which will be parsed based on class/method descriptions in the code base.

@andreped andreped added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 2, 2023
@andreped andreped self-assigned this Jun 2, 2023
@andreped
Copy link
Collaborator Author

andreped commented Jun 2, 2023

Made draft PR #48.

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 or request
Projects
Status: No status
Development

No branches or pull requests

1 participant