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

DOC: tab sync based on same tab name using sync statement #18887

Merged
merged 7 commits into from Jul 16, 2023

Conversation

RobPasMue
Copy link
Contributor

@RobPasMue RobPasMue commented Jul 15, 2023

Reference issue

None related.

What does this implement/fix?

When selecting an OS tab in the documentation you can also use :sync: to easily sync all tabs related (i.e. with the same name). See the video attached.

Additional information

video.webm

@RobPasMue
Copy link
Contributor Author

Pinging @melissawm since she is attending SciPy Conf '23 as Sprint organizer

doc/source/conf.py Outdated Show resolved Hide resolved
@RobPasMue RobPasMue changed the title DOC: tab sync based on same tab name using sphinx-tabs DOC: tab sync based on same tab name using sync statement Jul 15, 2023
Copy link
Member

@tupui tupui left a comment

Choose a reason for hiding this comment

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

Thank you @RobPasMue! That's a good addition 😃

Could you also sync venv/conda on this page?

For the next commit, could you please add in its message the following to skip some of the CI: [skip actions] [skip cirrus]. We only need to build the doc for doc only PRs.

@rgommers
Copy link
Member

Seems like a good idea to me, thanks @RobPasMue

This implies adding the dependency

This works as-is with sphinx-design (see https://sphinx-design.readthedocs.io/en/latest/tabs.html) which is already a dependency, so no need to add a new dependency.

@RobPasMue
Copy link
Contributor Author

This works as-is with sphinx-design (see https://sphinx-design.readthedocs.io/en/latest/tabs.html) which is already a dependency, so no need to add a new dependency.

Thanks @rgommers - indeed, I tried it first with sphinx-tabs. @melissawm here at SciPy Conference mentioned to me that the dependency had been dropped some time ago in favor of sphinx-design. That's when I started investigating how to do it with sphinx-design. I just edited the PR description 😄

@RobPasMue
Copy link
Contributor Author

Thank you @RobPasMue! That's a good addition 😃

Could you also sync venv/conda on this page?

For the next commit, could you please add in its message the following to skip some of the CI: [skip actions] [skip cirrus]. We only need to build the doc for doc only PRs.

Sure, you can count on it @tupui! Working on it right away =)

@RobPasMue RobPasMue requested a review from tupui July 16, 2023 13:26
Copy link
Member

@tupui tupui left a comment

Choose a reason for hiding this comment

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

Thank you for the update @RobPasMue! LGTM now and we can merge 🚀 🙌

@tupui tupui merged commit b6e62c7 into scipy:main Jul 16, 2023
25 checks passed
@tupui tupui added this to the 1.12.0 milestone Jul 16, 2023
@tupui tupui added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks and removed scipy.interpolate labels Jul 16, 2023
lucascolley pushed a commit to lucascolley/scipy that referenced this pull request Jul 16, 2023
lucascolley pushed a commit to lucascolley/scipy that referenced this pull request Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants