Add command line reference guide to the Tutorials page
Closes #202
This PR adds a reference guide for the commands used throughout the package creation process. The commands are grouped into four categories:
- Environment Setup
- Package Development
- Package Publishing
- Miscellaneous Commands
Adds a new section to the Tutorials page and a corresponding grid to the landing page. See screenshots for a preview from my local docs build.
- To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1206982522639506
@calekochenour thank you for this!! just a note that i have seen it and i'll put it on my todo list to review in the upcoming week!!
@all-contributors please add @calekochenour for code, review
@lwasser Thanks for the review and comments. I will address them soonest. I did test this on Windows, so some of the commands are OS-specific. The example commands at the moment reflect what I actually tested, except for the upload to Conda-forge. Happy to add more for various operating systems, pip vs. pipx, as well as your other comments.
@JacksonBurns Thanks for your comments as well. I will address these soon.
hey friends! just checking in. what do we need to do to get this merged?
i thijnk from my perspective @calekochenour we can just be super specific about the windows commands (telling users this is for windows) and then we can go back in a separate PR and add mac/linux commands later! if that is the case then i think the changes would be mostly focused on headers or section text that specify "windows" and then maybe a note that says we will be updating this with mac/linux commands in the future. let me know what you think! Let's keep the changes simple so we can get this merged!
@lwasser Thanks for the ping on this. I have not forgotten. I will look to make the updates/changes soonest. What you suggested in your latest comment makes sense to me.
@lwasser @JacksonBurns @willingc I have addressed all comments with my latest commits. Please let me know if there are any outstanding issues and/or any comments that I have missed. Thanks in advance.
I'll need to troubleshoot why this is not building. I tried to fix the merge conflict.
I just reran CI. ~There is one warning still present related to a toctree caption: https://github.com/pyOpenSci/python-package-guide/actions/runs/10276079239/job/28435889487?pr=211#step:9:74~
Update: I fixed the CI warning. I will rerun CI again in a bit to fix the flaky htmlproofer error.
Thanks for the updates @calekochenour. ~Please reach out if you need guidance on fixing this warning.~ 👍🏼
@lwasser @JacksonBurns If you can approve this PR, we can merge as the CI errors are now resolved :smile:
Hi everyone! I am officially becoming a blocker on our repos. My goal is to unblock.
@JacksonBurns, I just invited you to our organization and added you to this repo so you can approve PRs and triage if you wish!
Given we have two approvals, I will merge this pr now. @calekochenour I'm sorry this has taken so long to merge. I'm trying to set up structures so that I'm not a blocker on PRs - it is just taking time! I can no longer review everything because we have so many people contributing which is awesome!
@lwasser thanks! Just accepted.