-
-
Notifications
You must be signed in to change notification settings - Fork 792
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 Setup and Building page for commands on different systems #1226
Add inline tabs on Setup and Building page for commands on different systems #1226
Conversation
I am open to input about what to do about this build error. It seems the |
The error:
It can't find the .. _macOS and OS X:
.. _macOS: |
Okay, that was my first instinct, but did not work on my local machine. It still can't find both Also peculiar: the tab for Linux has a .. in the "Install dependencies" section
.. tab:: Unix
.. _deps-on-linux:
Linux
----- One thing that did seem to work is specifying the reference label name (Sphinx docs). The following code removes one of the "Failed to create a cross reference" warnings: .. in the "Install dependencies" section
on :ref:`Linux <deps-on-linux>` and :ref:`macOS <macOS>`. On Windows, This would require changing the one other reference in Should I try that or do you have another idea? |
We also have this earlier in the logs:
Perhaps sphinx_inline_tabs doesn't like any headers inside tabs? |
I did notice those section titles were not rendering in the HTML, either. I'm thinking this page cannot make use of the inline tabs as they are currently. The compile, build, and dependency installation processes are all so different that they don't have the same steps. I feel like this page works better as a traditional linear read with section headers. This is a Let me know how you feel about this. |
I think this only applies to Linux/macOS, there's no How about this? Add Linux and macOS tabs to the "Install dependencies" section. We can move all the references just above the header: .. _build-dependencies:
.. _deps-on-linux:
.. _macOS and OS X:
.. _macOS:
Install dependencies
====================
This section explains how to install additional extensions (e.g. ``zlib``)
on :ref:`Linux <deps-on-linux>` and :ref:`macOS`. On Windows,
extensions are already included and built automatically.
.. tab:: Linux
[...]
.. tab:: macOS
[...] And that can be enough for this page, for now. We can consider followups later. |
Ahhhh, okay, I think I got mixed up because I saw this one, but it's in the I think that's a good way forward. I just pushed two commits and my section title errors have disappeared locally. |
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.
Please also add the JS snippet at the top ;)
I think that was everything! I can't believe I missed the JavaScript, lollollol |
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.
Thank you!
This PR should close a single TODO in #1196.
This page is a little more complicated than the previous others.
Compile and build has a long list of instructions that are the same for Unix and macOS, so I chose to group them under a single tab rather than duplicate them.
Install dependencies directly refers to "Linux" which is different than the "Unix" we've been using in the other pages. I decided to change the tab to a consistent "Unix" but left the rest of the section unchanged.
📚 Documentation preview 📚: https://cpython-devguide--1226.org.readthedocs.build/getting-started/setup-building/