Intégrer un graphique intrigant dans un document Sphinx

Question

J'ai essayé d'utiliser nbsphinx pour incorporer un Jupyter ordinateur portable contenant plotly parcelles, mais les parcelles ne sont pas dans la documentation, même si ils ont l'air bien sur la Jupyter ordinateur portable.

Comment puis-je intégrer un plotly graphique dans Sphinx de la documentation? J'ai pu les inclure comme des images, mais est-il une meilleure façon? Il serait agréable d'avoir de l'interactivité!

Ce que je veux faire est de répliquer cette page. Il a Jupyter notebook style dans et hors blocs, et il montre interactive parcelles faite à l'aide de plotly. Comment puis-je le faire?

GitHub question soulevée ici.

Answer 1

Le graphique lui-même est un fichier HTML à l'intérieur du carnet de notes jupyter. Vous pouvez ouvrir le fichier notebook.ipnb dans n'importe quel éditeur de texte, trouver où commence le HTML du graphique, copier tout ce code html dans le fichier html et l'enregistrer, par exemple a.html, puis insérer simplement du code HTML brut dans le document RST.

 .. raw:: 
    :file: a.html
 

Answer 2

Je vois deux solutions pour intégrer votre ordinateur portable cellules avec plotly chiffres dans un sphinx de la documentation.

1. Convertir l'ordinateur portable au format html à l'aide de nbconvert ou nbsphinx. Assurez-vous d'utiliser l' notebook moteur de rendu afin d'y inclure les plotly javascript bundle (c'était peut être la raison pour laquelle vos chiffres ne s'affiche pas): voir https://plot.ly/python/renderers/ pour la documentation sur plotly les convertisseurs. Ensuite, vous pouvez inclure le code html de votre sphinx doc avec diverses solutions (voir Inclure autonome de la page HTML dans sphinx document).
2. L'utilisation de sphinx-galerie (https://sphinx-gallery.github.io/) avec ses plotly grattoir. Avec sphinx-galerie d'écrire votre page de doc comme un script python qui est converti par le sphinx-galerie d'extension de sphinx. Afin de configurer le grattoir à voir https://sphinx-gallery.github.io/advanced.html#integrate-custom-scrapers-with-sphinx-gallery. Nous avons également un minimum de dépôt montrant comment utiliser plotly et le sphinx-galerie d'ensemble dans https://github.com/plotly/plotly-sphinx-gallery. https://github.com/plotly/plotly-sphinx-gallery

Answer 3

À partir de Python, vous pouvez générer le code HTML pour incorporer des graphiques Plotly avec la fonction plotly.tools.get_embed.

 import plotly.tools as tls

tls.get_embed('https://plot.ly/~chris/1638')