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

Add inline tabs on Documentation Getting Started page for commands on different systems #1224

Merged
merged 5 commits into from
Nov 23, 2023

Conversation

lancegoyke
Copy link
Contributor

@lancegoyke lancegoyke commented Nov 18, 2023

This PR should close a single TODO in #1196.

There is a little bit of discussion in the Build using make / make.bat section. My understanding is the commands are the same so I didn't try to make tabs for them all, but we can adjust if you believe that's better.


📚 Documentation preview 📚: https://cpython-devguide--1224.org.readthedocs.build/documentation/start-documenting/

@hugovk
Copy link
Member

hugovk commented Nov 18, 2023

On this page, we originally had:

On Unix platforms that support make (including Linux, macOS and BSD)...

So we can lump all those under Unix, and just have two tabs: Unix and macOS.

The JavaScript tab selector (please add it like #1223 (comment)) will default to Unix, so it that's fine for macOS.


There is a little bit of discussion in the Build using make / make.bat section. My understanding is the commands are the same so I didn't try to make tabs for them all, but we can adjust if you believe that's better.

Yeah, let's see how it goes with tabs here.

So for the Unix tab, just the Unix bit of this:

image

And for the Windows tab, the Windows bit of this, plus "Important" note:

image

We also have a few make X commands on this page. We can now tabify these too, so Windows users can copy/paste their .\make X versions.

Thanks!

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

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

ISTM that all the commands on this page that are valid for Unix are also valid for macOS, so we should be able to merge those two tabs. Using Unix/macOs as tab name throughout the page should be fine as well, but I haven't tested it.

documentation/start-documenting.rst Outdated Show resolved Hide resolved
documentation/start-documenting.rst Outdated Show resolved Hide resolved
@lancegoyke
Copy link
Contributor Author

lancegoyke commented Nov 20, 2023

I pushed some new commits with those changes.

Here's that intro on the makefile for Unix:

image

And for Windows:

image

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.

Thanks again!

@hugovk hugovk merged commit 1909f67 into python:main Nov 23, 2023
4 checks passed
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.

3 participants