Recommend GitHub CLI for easier bootstrapping #946
Conversation
|
I think promoting |
|
Sphinx Inline Tabs could be useful to show the two different options. It's used on https://packaging.python.org/en/latest/tutorials/packaging-projects/ to select between Unix/macOS and Windows (and also Hatchling, setuptools, Flit and PDM):
It's nice that you when you select one tab, it flips for the whole page:
Also used for example at https://pip.pypa.io/en/stable/getting-started/ |
|
Agreed that showing both options, one with a specific one wrapper tool and the more manual one with the "standard" tooling, would be helpful (I personally still use @hugovk is there a built-in way to link the tab choices, so that clicking on one will automatically switch all of them, or is that a custom extension on the packaging site? That definitely is a big boon for usability. |
|
@CAM-Gerlach Yes, it's built-in!
And see the demo at https://sphinx-inline-tabs.readthedocs.io/en/latest/ |
|
@jaraco, do you want to update the PR to use |
|
While I can see the value in using sphinx-inline-tabs, I worry that the maintenance burden is getting out of hand, especially considering that the docs exist in two places, so anything that happens probably needs to be duplicated, so duplicating the techniques would be a multiplier on the existing multiple. It's probably best to provide one technique. I wouldn't be opposed to someone adopting this diff to use sphinx-inline-tabs, but I'm not inclined to do it myself. |
As I was working on #943, I realized it might be easier to direct users to use the GitHub CLI instead of all of the manual steps.
Thoughts?