Title: Better RTD implementation of examples/documentation · Issue #32 · proplot-dev/proplot · GitHub
Open Graph Title: Better RTD implementation of examples/documentation · Issue #32 · proplot-dev/proplot
X Title: Better RTD implementation of examples/documentation · Issue #32 · proplot-dev/proplot
Description: Currently, contributors cannot add examples. I generate examples from a big ipython notebook and convert them to RST with a shell script that calls nbconvert and does some regex magic to repair RST-style Sphinx module links embedded in t...
Open Graph Description: Currently, contributors cannot add examples. I generate examples from a big ipython notebook and convert them to RST with a shell script that calls nbconvert and does some regex magic to repair RST...
X Description: Currently, contributors cannot add examples. I generate examples from a big ipython notebook and convert them to RST with a shell script that calls nbconvert and does some regex magic to repair RST...
Opengraph URL: https://github.com/proplot-dev/proplot/issues/32
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Better RTD implementation of examples/documentation","articleBody":"Currently, contributors cannot add examples. I generate examples from a big ipython notebook and convert them to RST with a shell script that calls `nbconvert` and does some regex magic to repair RST-style Sphinx module links embedded in the Markdown notebook cells (e.g. by default, `nbconvert` turns `` `~proplot.subplots.Figure` `` into ` ``~proplot.subplots.Figure`` `). This workflow also requires that *every cell* has already been executed, but committing cells with executed output is bad practice IMO -- ProPlot currently does not track or push cell output, thanks to `nbstripout` commands I've added to `.git/info/attributes` (see [nbstripout](https://github.com/kynan/nbstripout) for details).\r\n\r\nIn the near future, I need to commit the example notebook, use `nbsphinx` to automatically run each cell instead of running the cells manually myself, and configure `nbsphinx` with a formal `nbconvert` template/filter that repairs the links.\r\n\r\nAlternatively, I may fork `nbsphinx` and implement this manually. Then I could add both my fork of `sphinx-automodapi` and `nbsphinx` as submodules inside proplot.","author":{"url":"https://github.com/lukelbd","@type":"Person","name":"lukelbd"},"datePublished":"2019-09-05T22:58:34.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/32/proplot/issues/32"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:2661c4ff-adb4-3aed-e5e7-20c354bee9e7 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | AE40:6FF42:201B11C:2A80ECF:697C3A24 |
| html-safe-nonce | d10b7e0cb3729c77fe066d4462e6ceb43bcbb00458cfda3e6e2cf7e3cb86bba0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRTQwOjZGRjQyOjIwMUIxMUM6MkE4MEVDRjo2OTdDM0EyNCIsInZpc2l0b3JfaWQiOiI2ODU2NTY2OTgwODcwOTQ1MzE3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | ab537ffa58b7dd17cf42347d4e0fb9843425f77ebd0363041bfc0ac6f9cc3c47 |
| hovercard-subject-tag | issue:490049979 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/proplot-dev/proplot/32/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ec9dc89fb445aa5459215a751d479e25a5e18e445391c7adeba0464a668d7492/proplot-dev/proplot/issues/32 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ec9dc89fb445aa5459215a751d479e25a5e18e445391c7adeba0464a668d7492/proplot-dev/proplot/issues/32 |
| og:image:alt | Currently, contributors cannot add examples. I generate examples from a big ipython notebook and convert them to RST with a shell script that calls nbconvert and does some regex magic to repair RST... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | lukelbd |
| hostname | github.com |
| expected-hostname | github.com |
| None | da4f0ee56809799586f8ee546b27f94fe9b5893edfbf87732e82be45be013b52 |
| turbo-cache-control | no-preview |
| go-import | github.com/proplot-dev/proplot git https://github.com/proplot-dev/proplot.git |
| octolytics-dimension-user_id | 108025793 |
| octolytics-dimension-user_login | proplot-dev |
| octolytics-dimension-repository_id | 113293661 |
| octolytics-dimension-repository_nwo | proplot-dev/proplot |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 113293661 |
| octolytics-dimension-repository_network_root_nwo | proplot-dev/proplot |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 787d8d274e314f52ce6d846c7581f9476d8dc736 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width