Skip to content

Conversation

rai-pranav
Copy link
Collaborator

@rai-pranav rai-pranav commented Aug 25, 2025

Added documentation to various functions, and added sphinx related files.

@rai-pranav rai-pranav requested a review from oliche August 25, 2025 09:41
@rai-pranav rai-pranav marked this pull request as ready for review August 25, 2025 09:41
@rai-pranav
Copy link
Collaborator Author

Fixes #16

Copy link
Member

@oliche oliche left a comment

Choose a reason for hiding this comment

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

This looks all good.
A few small changes before to commit this:

  • it seems we have changed the docstring format to Google. No problem but this should be mentionned in the README.md in the contribution section.
  • this README.md should not contain any documentation, but link to the actual sphinx website instead
  • in the docs folder, there should be a README.md file explaining how to build the documentation. An example can be found here: https://github.com/int-brain-lab/ibldevtools/tree/master/00_dev_site, this small readme explains a dev how to build the doc
    Thanks for working on the documentation !

@rai-pranav rai-pranav force-pushed the sphinx_documentation branch 5 times, most recently from d65c087 to d38a6a2 Compare September 4, 2025 10:08
@rai-pranav
Copy link
Collaborator Author

@oliche I have add the changes you have requested. I would need to understand from you , how to create the documentation website (for e.g. docs.internationalbrainlab.org/ibleatools) . And then I can add it on the README.md file. For now, I am just referencing a index.rst file from the documentation.

@rai-pranav rai-pranav merged commit 3aeef97 into main Sep 5, 2025
2 checks passed
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