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

DOC: simplify API documentation #14

Merged
merged 5 commits into from
Aug 28, 2024
Merged

DOC: simplify API documentation #14

merged 5 commits into from
Aug 28, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Aug 27, 2024

Removes audpsychometric.datasets sub-module, and flatten hierachy in API documentation:

image

The documentation, that listed the available datasets was moved to the examples in the docstring:

image

And we also show an example dataset now:

image

@hagenw hagenw requested a review from ChristianGeng August 27, 2024 14:40
Copy link
Member

@ChristianGeng ChristianGeng left a 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

@hagenw
Copy link
Member Author

hagenw commented Aug 28, 2024

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 -W in the Github action let's the test fails (raise error for warning), which you usually don't want when building locally.

Copy link
Member

@ChristianGeng ChristianGeng left a 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.

@hagenw hagenw merged commit f7296ee into main Aug 28, 2024
7 checks passed
@hagenw hagenw deleted the simplify-api-doc branch August 28, 2024 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants