-
Notifications
You must be signed in to change notification settings - Fork 7
Update the documentation following the PyPI changes #127
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here are some suggestions for taking a slightly different approach to this docs update, by:
- Syncing the docs to the state of the main branch following the merge of #117, #118, #120, #126.
- Describing dependency installation a little more generic, only recommending the use of
uv. - Restructuring things to be more in line with the rest of the documentation - though this may need an even larger overhaul soon.
Furthermore, I think these other parts of the docs need an update as part of this PR:
- The Schedules tests section needs a minor update to reflect our new uv based setup.
- The Docs dependencies section needs an update about installing the "docs" dependency group from the pyproject.toml file - similar to how the "test" dependency installation is described in this PR.
- The pre-commit section needs an update about installing the "lint" dependency group from the pyproject.toml file - similar to how the "test" dependency installation is described in this PR.
- I think the CLI internals section should just assume you have installed cotainr via pip and, thus, only mention running
cotainr build ...etc. Maybe it should still mention thebin/cotainrscript as an alternative to the pip installed entrypoint.
Co-authored-by: Christian Schou Oxvig <[email protected]>
Co-authored-by: Christian Schou Oxvig <[email protected]>
Chroxvi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Look good to me. I noted two typos, you might want to correct.
Co-authored-by: Christian Schou Oxvig <[email protected]>
Chroxvi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is ready for merge.
The major edits in the PR is related to #102 , as seen in the following sections:
https://cotainr--127.org.readthedocs.build/en/127/development/test_suite_ci_cd.html#the-test-suite
https://cotainr--127.org.readthedocs.build/en/127/development/test_suite_ci_cd.html#continuous-deployment
https://cotainr--127.org.readthedocs.build/en/127/development/releasing.html#release-process
https://cotainr--127.org.readthedocs.build/en/127/getting_started.html
The corresponding README is in #120 as it is not in the documentation
closes #102