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

Documentation fixes #3069

Merged
merged 4 commits into from Dec 3, 2020
Merged

Documentation fixes #3069

merged 4 commits into from Dec 3, 2020

Conversation

Drulex
Copy link
Collaborator

@Drulex Drulex commented Dec 1, 2020

Closes #3056

@Drulex Drulex marked this pull request as ready for review December 1, 2020 16:38
@Drulex
Copy link
Collaborator Author

Drulex commented Dec 1, 2020

Haven't performed an exhaustive check of a API documentation since I don't think a lot of people actually use it, but I went over the recently added modules that were missing.

Copy link
Member

@joshuacwnewton joshuacwnewton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I notice the spacing issues that you fixed is also present in math. (e.g. https://spinalcordtoolbox--3069.org.readthedocs.build/en/3069/dev_section/api.html#spinalcordtoolbox.math.compute_similarity) Now might be a good time to fix this, too. LGTM otherwise.

I'm surprised Sphinx doesn't emit a warning for this!

@Drulex Drulex self-assigned this Dec 3, 2020
@Drulex Drulex added the documentation category: readthedocs, sourceforge, or SCT courses label Dec 3, 2020
@joshuacwnewton joshuacwnewton merged commit 8da39b1 into master Dec 3, 2020
@joshuacwnewton joshuacwnewton deleted the aj/3056-doc-update branch December 3, 2020 16:48
@lrouhier lrouhier added this to the next-release milestone Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation category: readthedocs, sourceforge, or SCT courses
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python API documentation page needs to be updated following recent refactors
3 participants