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

Configure documentation #27

Merged
merged 3 commits into from
Aug 21, 2024
Merged

Configure documentation #27

merged 3 commits into from
Aug 21, 2024

Conversation

me-pic
Copy link
Contributor

@me-pic me-pic commented Aug 14, 2024

Starts addressing #26. Currently this PR only setup the required files to build the docs. The content has not been added so far...

Proposed Changes

  • Add docs/ folder containing : conf.py, Makefile, index.rst, installation.rst, api.rst
  • Add README.rst file a in root

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@smoia smoia added the Documentation This issue or PR is about the documentation label Aug 21, 2024
@smoia smoia changed the title Configure docs Configure documentation Aug 21, 2024
@smoia smoia merged commit d0b4236 into physiopy:master Aug 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation This issue or PR is about the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants