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

updates to glue docs #77

Merged
merged 2 commits into from
Mar 16, 2020
Merged

updates to glue docs #77

merged 2 commits into from
Mar 16, 2020

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Mar 15, 2020

This adds a few updates to the glue docs page as I was trying it out. It adds some more context about in-line images, tries to clean up the analysis code a bit so it is less-distracting, and clarifies a few points here and there.

Check out the page here: https://197-241268229-gh.circle-artifacts.com/0/html/use/glue.html

Check out the table at the bottom, pretty cool that it "just works"! https://197-241268229-gh.circle-artifacts.com/0/html/use/glue.html#pasting-into-tables

@jstac
Copy link
Member

jstac commented Mar 15, 2020

This is brilliant. I love this feature. Great work and great docs.

Would glu be a better synonym for glu:any --- it seems more consistent...?

jstac
jstac previously approved these changes Mar 15, 2020
@chrisjsewell
Copy link
Member

Good doc improvements 👍

This is brilliant. I love this feature. Great work and great docs.

Would glu be a better synonym for glu:any --- it seems more consistent...?

Thanks @jstac, this is what I meant when I kept banging on about the Model-View pattern, it just makes life so much easier 😄

@jstac
Copy link
Member

jstac commented Mar 15, 2020

I have seen the light 😄

@najuzilu and @mtiley, please note these features. As everything gets tied together, they can be included in the converted QuantEcon material. More generally, the idea is to convert the material in order to replicate our output, as well as to exploit new features in order to make the output even better.

@chrisjsewell
Copy link
Member

chrisjsewell commented Mar 15, 2020

Another use case that might be worth documenting, is that now you could have a notebook(s) that doesn't actually show up in the documentation (you signify this to sphinx by adding "orphan: True" in the notebook metadata, see file-wide-metadata), then you can have a separate markdown file that uses these roles/directives to show selected figures/data from one or more notebooks.

I've talked about this use case before; when you want to use the notebook(s) as a "log" of your data analysis, then have a separate document which is the final "publishable" output.

@choldgraf
Copy link
Member Author

choldgraf commented Mar 15, 2020

I just added a commit that:

  • Adds an orphaned notebook and pastes it into the glue.ipynb notebook
  • Replaces {glu:any} with {glu:} (I assume that {glu} isn't possible? It didn't work for me)
  • Slight reconfiguration of sections etc

@chrisjsewell
Copy link
Member

I assume that {glu} isn't possible? It didn't work for me

No, the : denotes to sphinx that the directive is part of a domain

@choldgraf choldgraf merged commit ab4ba1d into master Mar 16, 2020
@choldgraf choldgraf deleted the sparklines branch March 16, 2020 23:58
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.

None yet

3 participants