-
Notifications
You must be signed in to change notification settings - Fork 71
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
Would it be possible to define info in a data file ? #224
Comments
I do this all the time with Sphinx, definitely possible! One example is the executablebooks gallery https://executablebooks.org/en/latest/gallery/ Which is generated from a yaml file. The code to do that is here https://github.com/executablebooks/meta/blob/main/docs%2Fconf.py#L104 You could also do this outside of conf.py if you used a jupyter notebook w a cell that outputted markdown (so it'd be parsed as Myst) |
Are there directives for {displaying, editing, validating} "YAML" {JSON,
JSON-LD, YAML, YAML-LD, JSON Schema,} in {docutils, sphinx / myST,
jupyter-book, nbdev, IPython.display, or nbsphinx, }?
- Tabs / Panes / Controls
- edit YAML with validation
- validate YAML
- view raw YAML
- view YAML
Use Cases:
- Specify title, authors, abstract as schema.org linked data at the top of
a notebook
- Append YAML data to a [LD: LinkedData] resultdict object in one or more
cells of a notebook, and validate it all at once and IDK optionally on
insert?
…On Mon, May 27, 2024, 11:09 AM Chris Holdgraf ***@***.***> wrote:
I do this all the time with Sphinx, definitely possible!
One example is the executablebooks gallery
https://executablebooks.org/en/latest/gallery/
Which is generated from a yaml file. The code to do that is here
https://github.com/executablebooks/meta/blob/main/docs%2Fconf.py#L104
You could also do this outside of conf.py if you used a jupyter notebook w
a cell that outputted markdown (so it'd be parsed as Myst)
—
Reply to this email directly, view it on GitHub
<#224 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAMNSYORZLS2D7DPU5AQRTZENEEPAVCNFSM6AAAAABIK3B33OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZTGY3DSOJXGA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Mostly people.md and likely a few other things.
On Jupyter.github.io most pages are generated from a yaml data file:
https://github.com/jupyter/jupyter.github.io/blob/main/about.html#L22-L74 for example.
This would make it easier to include the same informations on multiple page instead of having to synchronize instead of always having to jump between multiple pages.
The text was updated successfully, but these errors were encountered: