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

Readthedocs: Add version switch and update URL #2324

Merged
merged 2 commits into from
Sep 24, 2024

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Sep 24, 2024

This does two things:

  • Add version switch to choose between the stable and latest docs
  • And update the URLs to the shorter mesa.readthedocs.io/stable (instead of mesa.readthedocs.io/en/stable)

image

Moving towards the shorter mesa.readthedocs.io/stable/ (instead of mesa.readthedocs.io/en/stable/)
@EwoutH EwoutH added the docs Release notes label label Sep 24, 2024
Allows easy switching between stable and latest
@EwoutH EwoutH force-pushed the rtd_url_version_selector branch from 902605b to 9d16366 Compare September 24, 2024 19:58
Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 -0.0% [-0.9%, +0.8%] 🔵 +0.1% [-0.1%, +0.2%]
BoltzmannWealth large 🔵 -0.0% [-0.3%, +0.3%] 🔵 -0.0% [-0.7%, +0.6%]
Schelling small 🔵 +0.3% [-0.0%, +0.7%] 🔵 +0.0% [-0.2%, +0.2%]
Schelling large 🔵 -0.1% [-0.5%, +0.2%] 🔵 +2.4% [+1.2%, +3.6%]
WolfSheep small 🔵 +0.3% [+0.1%, +0.5%] 🔵 +1.2% [+1.1%, +1.4%]
WolfSheep large 🔵 -0.3% [-1.2%, +0.4%] 🔵 -1.2% [-4.4%, +1.3%]
BoidFlockers small 🔵 +2.2% [+1.7%, +2.6%] 🔵 +0.2% [-0.7%, +0.9%]
BoidFlockers large 🔵 +1.8% [+1.3%, +2.2%] 🔵 -0.1% [-0.6%, +0.3%]

@EwoutH
Copy link
Member Author

EwoutH commented Sep 24, 2024

Only way to test this is to merge and deploy on the main branch, since the switch URL points to that. Let's go!

@EwoutH EwoutH merged commit 8d1dd13 into projectmesa:main Sep 24, 2024
10 of 12 checks passed
@Corvince
Copy link
Contributor

Wait, did you just nuke all existing links out there? 😅 If you want to do that they must at least redirect. If that's not possible please revert this :)

@EwoutH
Copy link
Member Author

EwoutH commented Sep 24, 2024

No, I would never do that! I think I figured it out, can you check if it works on your side? https://mesa.readthedocs.io/en/latest/tutorials/visualization_tutorial.html

@Corvince
Copy link
Contributor

Corvince commented Sep 25, 2024

Haha, good one, I fell for that...

You just got me worried because I only tested https://mesa.readthedocs.io/en/stable and that gives a 404. But the other links seem to redirect correctly.

@EwoutH
Copy link
Member Author

EwoutH commented Sep 25, 2024

Couldn't not do it ;)

That one now also works, I was redirecting /en/stable/*, now /en/stable*

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants