-
Notifications
You must be signed in to change notification settings - Fork 0
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
DOC: simplify API documentation #14
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When building the docs locally, I see that there is a dfiference between the github action and CONTRIBUTING.rst
.
I wonder whether there is a reason for that?
python -m sphinx docs/ docs/_build/ -b html -W
python -m sphinx docs/ build/sphinx/html -b html
I changed it to python -m sphinx docs/ build/html -b html and python -m sphinx docs/ build/html -b html -W to use the same build folder. The additional |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There were only minor formalities that have been addressed.
Approving this.
Removes
audpsychometric.datasets
sub-module, and flatten hierachy in API documentation:The documentation, that listed the available datasets was moved to the examples in the docstring:
And we also show an example dataset now: