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

Use Sphinx Inline Tabs to organise installation per OS #6764

Merged
merged 10 commits into from
Dec 4, 2022

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Nov 28, 2022

Follow on from #6755 / #6756

Changes proposed in this pull request:

  • Use Sphinx Inline Tabs to group the installation instructions by operating system
  • This helps hide irrelevant information on long, detailed page
  • If, for example, you click the macOS tab in the first tab group, it also opens the macOS tab in the second group
  • Because the subheaders are gone, I added in .. _Linux Installation: etc. to avoid linkrot
  • I re-ordered them to go: Linux, macOS, Windows, [Windows variant,] FreeBSD, [Android]
    • My thinking was to put the main three first, in order of "likelihood" to needs to follow these instructions, then the others afterwards, but happy to change it

image

image

Plus some other cleanup:

  • Like our top-level Makefile, inline the .PHONY targets to help avoid omissions in the docs Makefile (and texinfo, info, livehtml and serve were missing)
  • Add serve and livehtml to make -C docs help
  • EditorConfig: three-space indents for RST

Demo

https://pillow--6764.org.readthedocs.build/en/6764/installation.html

docs/Makefile Outdated Show resolved Hide resolved
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
.editorconfig Outdated Show resolved Hide resolved
.editorconfig Outdated Show resolved Hide resolved
hugovk and others added 2 commits December 3, 2022 07:43
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
@radarhere radarhere merged commit 6a2545f into python-pillow:main Dec 4, 2022
@hugovk hugovk deleted the docs-tabs branch December 4, 2022 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants