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.

Sign up for GitHub

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

Jump to bottom

render plotly in our docs, show code/doc version #231

Merged
merged 18 commits into from
Mar 4, 2025
Merged

render plotly in our docs, show code/doc version #231

merged 18 commits into from
Mar 4, 2025

Conversation

MMathisLab
Copy link
Member

@MMathisLab MMathisLab commented Mar 1, 2025 •
edited
Loading

The issue was that plotly was not rendering in our sphinx docs

Solution is from: spatialaudio/nbsphinx#128 (comment)

Also took inspiration from VectorInstitute/cyclops#591

Added version builds

@MMathisLab
Update conf.py
327e326 
- fig rendering of plotly figs in docs
@MMathisLab MMathisLab requested a review from stes March 1, 2025 20:33
@cla-bot cla-bot bot added the CLA signed label Mar 1, 2025
@MMathisLab MMathisLab changed the title Update conf.py [ wip ] Update conf.py Mar 1, 2025
@MMathisLab MMathisLab removed the request for review from stes March 2, 2025 09:15
@MMathisLab MMathisLab changed the title [ wip ] Update conf.py render plotly in our docs Mar 2, 2025
@MMathisLab MMathisLab requested a review from stes March 2, 2025 09:53
@MMathisLab MMathisLab changed the title render plotly in our docs render plotly in our docs, show code/doc version Mar 2, 2025
@MMathisLab MMathisLab self-assigned this Mar 2, 2025
@MMathisLab MMathisLab added the documentation Improvements or additions to documentation label Mar 2, 2025
@MMathisLab MMathisLab requested a review from CeliaBenquet March 4, 2025 16:52
stes
stes approved these changes Mar 4, 2025
View reviewed changes
Copy link
Member

@stes stes left a comment

Choose a reason for hiding this comment

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

as discussed, there might be some bumps in the github action build after merging, but lets see what happens. lgtm otherwise

@MMathisLab MMathisLab merged commit b677e67 into main Mar 4, 2025
12 checks passed
@MMathisLab MMathisLab deleted the MMathisLab-plotly-docs branch March 4, 2025 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stes stes stes approved these changes

@CeliaBenquet CeliaBenquet Awaiting requested review from CeliaBenquet

Assignees

@MMathisLab MMathisLab

Labels
CLA signed documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MMathisLab @stes