Fix issues #1243, #1294 and #1659 #1888
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Description
This PR should fix issues #1243, #1294 and #1659 by creating the .rst files of the geomstats api
The command "sphinx-apidoc -o docs/api geomstats" generates the .rst files of the api.
It must be executed before the sphinx-build.
The local tests I made on my windows computer seems to work fine, however there could be some tuning to do to make it work on the server (most espcially writing the directory names)
Additional thoughts:
Issue
#1243, #1294 and #1659
This fix will allow the api documentation to be in sync with any new approved commits in geomstats
Additional context