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

Move installation.rst to installation/*.rst #7832

Merged
merged 11 commits into from
Mar 6, 2024
Merged

Conversation

aclark4life
Copy link
Member

  • Add index
  • Move content to sections
  • Rearrange sections

Changes proposed in this pull request:

  • Adds navigation to Installation section
  • Rearrange sections to prioritize basic installation, followed by supported platforms and Python versions, followed by building from source and old releases
Screenshot 2024-02-24 at 6 36 01 PM

@aclark4life aclark4life added this to the 10.3.0 milestone Feb 24, 2024
@hugovk
Copy link
Member

hugovk commented Feb 25, 2024

My biggest concern is linkrot, existing links out will break and result in 404s.

For example, answers on Stack Overflow will no longer link to the correct place.

@aclark4life
Copy link
Member Author

@hugovk Good call, I've added a95ca25 to address that issue.

docs/conf.py Outdated Show resolved Hide resolved
@aclark4life
Copy link
Member Author

@hugovk Hmmm. Possibly if we add redirects on RTD according to pypa/packaging.python.org#1401 (comment) (with the core issue being whether or not link fragments are handled by the HTTP specification.) At that point, the discussion becomes more about weighing the benefit of adding navigation links to the installation section sidebar vs. breaking SO links, or SEO or whatever. I'm pretty happy with adding sphinx-reredirect and configuring RTD redirects as needed (assuming that works as expected, which I'm not inclined to believe it will and also feels a bit "heavy") and calling it a day, but that's just me. 🤷

aclark4life and others added 3 commits February 27, 2024 06:46
- Add index
- Move content to sections
- Rearrange sections
- For example, installation.html now redirects to installation/index.html
@aclark4life
Copy link
Member Author

Alternatively, we could leave note, something like:

Screenshot 2024-02-27 at 7 11 21 AM

- Re-add installation.rst
@aclark4life aclark4life requested a review from hugovk February 27, 2024 20:03
@aclark4life
Copy link
Member Author

@hugovk @radarhere OK to merge this one? 🤔

docs/conf.py Outdated Show resolved Hide resolved
@aclark4life
Copy link
Member Author

@hugovk @radarhere OK to merge this one? 🤔

Hold on to your butts

@aclark4life aclark4life merged commit f738bb9 into main Mar 6, 2024
59 of 60 checks passed
@aclark4life aclark4life deleted the install-doc-dir branch March 6, 2024 14:07
@hugovk hugovk mentioned this pull request Mar 6, 2024
@hugovk
Copy link
Member

hugovk commented Mar 6, 2024

Sorry for the late reply!

I think this is mostly fine, the original page was very large and it definitely looks much better for most of these to be their own page. 👍

I've opened #7858 with some little tweaks.

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