Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@Hzaatiti
Copy link
Collaborator

@Hzaatiti Hzaatiti commented Sep 21, 2023

Checklist

  • My pull request has a clear and explanatory title.
  • If necessary, my code is vectorized.
  • I added appropriate unit tests.
  • I made sure the code passes all unit tests. (refer to comment below)
  • My PR follows PEP8 guidelines. (refer to comment below)
  • My PR follows geomstats coding style and API.
  • My code is properly documented and I made sure the documentation renders properly. (Link)
  • I linked to issues and PRs that are relevant to this PR.

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:

  • the display is maybe not the best, other PR's could be needed to render the output better

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

@Hzaatiti Hzaatiti changed the title Fix issue #1243 Fix issues #1243, #1294 and #1659 Sep 21, 2023
Copy link
Collaborator

@ninamiolane ninamiolane left a comment

Choose a reason for hiding this comment

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

Nice!! Thanks.

@ninamiolane ninamiolane merged commit 76be6d1 into geomstats:master Sep 21, 2023
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