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

document that LaTeX does not work with Jupyter Notebook version 7 #4496

Merged
merged 3 commits into from
Feb 1, 2024
Merged

document that LaTeX does not work with Jupyter Notebook version 7 #4496

merged 3 commits into from
Feb 1, 2024

Conversation

newville
Copy link
Contributor

This updates the LateX documentation to state clearly that LaTeX rendering does not work with Jupyter Notebook 7. See #4336.

Documentation PR

  • I've seen the doc/README.md file
  • This change runs in the current version of Plotly on PyPI and targets the doc-prod branch OR it targets the master branch
  • If this PR modifies the first example in a page or adds a new one, it is a px example if at all possible
  • Every new/modified example has a descriptive title and motivating sentence or paragraph
  • Every new/modified example is independently runnable
  • Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
  • Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
  • The random seed is set if using randomly-generated data in new/modified examples
  • New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
  • Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
  • Imports are plotly.graph_objects as go / plotly.express as px / plotly.io as pio
  • Data frames are always called df
  • fig = <something> call is high up in each new/modified example (either px.<something> or make_subplots or go.Figure)
  • Liberal use is made of fig.add_* and fig.update_* rather than go.Figure(data=..., layout=...) in every new/modified example
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls in every new/modified example
  • fig.show() is at the end of each new/modified example
  • plotly.plot() and plotly.iplot() are not used in any new/modified example
  • Hex codes for colors are not used in any new/modified example in favour of these nice ones

@Coding-with-Adam
Copy link
Contributor

Thank you for the PR, @newville .
It's been challenging to find the main LaTex issue with Jupyter notebook version 7.

@LiamConnors can you please take a look at this doc-related PR?

doc/python/LaTeX.md Outdated Show resolved Hide resolved
@newville
Copy link
Contributor Author

@Coding-with-Adam I do not know where the problem lies or even where the actual error message is coming from.
In #4336 you may have read offers to help and requests for more information about how to do so. I did not see attempts to give insight or dig deeper into what is causing this failure of a documented feature.

If the problem is not even being looked into and no suggestions are being given about how to approach the problem, I think the only reasonable action is to change the documentation to clarify that latex formatting does not work.
It is pretty disappointing.

@Coding-with-Adam
Copy link
Contributor

Hi @newville
I'm also not sure where the exact problem is coming from.

If you're ok with Liam's comments to your PR, we can at least update the docs to give people a heads up.

@newville
Copy link
Contributor Author

newville commented Feb 1, 2024

Yes, please do.

@LiamConnors LiamConnors self-requested a review February 1, 2024 20:12
@LiamConnors LiamConnors merged commit f01ced1 into plotly:master Feb 1, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants