Skip to content

Add inline tabs on Quick Reference page for commands on different systems #1205

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

Merged
merged 7 commits into from
Oct 26, 2023

Conversation

lancegoyke
Copy link
Contributor

@lancegoyke lancegoyke commented Oct 25, 2023

This is for work on #1196

This PR introduces a new dependency: sphinx-inline-tabs

There were two design decisions I am not set on:

  1. Should we say "Unix" or "Linux"? I picked "Unix" because the setup docs say "Unix".
  2. Is the most useful order Unix, then macOS, then Windows. I would presume most developers are using macOS, but other examples I've seen start with "Linux" (e.g., PyPI, Pillow), so I put "Unix" first.

📚 Documentation preview 📚: https://cpython-devguide--1205.org.readthedocs.build/

@ghost
Copy link

ghost commented Oct 25, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

It's working well at https://cpython-devguide--1205.org.readthedocs.build/ :)

  1. Should we say "Unix" or "Linux"? I picked "Unix" because the setup docs say "Unix".

Let's keep the existing terminology for this PR, so "Unix".

  1. Is the most useful order Unix, then macOS, then Windows. I would presume most developers are using macOS, but other examples I've seen start with "Linux" (e.g., PyPI, Pillow), so I put "Unix" first.

Without knowing what operating systems our visitors use, I'd probably stick with the same order as given in the text: Unix, macOS, then Windows.

(For the main docs, it's something like 59% Windows, 22% macOS and 10% Linux, but the audience of this site could be different.)

@Mariatta
Copy link
Member

I looked at the preview and it looks great. Thanks for working on this.

@lancegoyke
Copy link
Contributor Author

@Mariatta and @hugovk -- thank you for your input! I have updated every item you both raised.

I made one additional change: requirements.txt is now in alphabetical order as that seemed similar to the extensions order in conf.py.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@pradyunsg pradyunsg merged commit 2a6cbd2 into python:main Oct 26, 2023
@pradyunsg
Copy link
Member

Thanks @lancegoyke! ^.^

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.

4 participants