Skip to content

Quarto docs rendering CI testing #1462

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

Closed
wants to merge 15 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions nbs/explanations/docs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -69,59 +69,6 @@
"Below is a diagram on how these concepts fit together."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```{mermaid}\n",
"flowchart TB\n",
" %%styles\n",
" style JN fill:#FFA500\n",
" style FP fill:#cfe5ed\n",
" style SF fill:#dff1dd,stroke-dasharray: 5 5;\n",
" style QMD fill:#7286bb,color:#fff;\n",
" classDef files fill:#ede8ce ;\n",
" classDef code fill:#5695c7,color:#fff;\n",
" classDef container fill:#f9f9f6;\n",
" \n",
" %% list of nodes\n",
" FP(<strong>Processing Pipeline</strong>\\ntransforms notebook based\\non directives and front-matter)\n",
" E(execnb)\n",
" SD(\"show_doc\")\n",
" SS(<strong>Static Site</strong>\\nHTML, CSS and Javascript)\n",
" CF(\"Intermediate Output is stored in the <code>_procs/</code> directory\\n\\n<i>(This is a full copy of your Quarto project)</i>\")\n",
" class SD,E code;\n",
" \n",
" subgraph SF[\"<strong>Source Files</strong>\"]\n",
" JN([Jupyter\\nNotebook])\n",
" QMD([\"Quarto\\nMarkdown\\n(.qmd)\"])\n",
" end\n",
" \n",
" \n",
" %% connections to things inside Notebook Processor (NBP)\n",
" JN -- json --> FP\n",
" E -. \"cell execution\" .- SD\n",
" \n",
" subgraph NBP [\"&nbsp;<strong>Notebook Processor\\n</strong>&nbsp;\"]\n",
" SD -.- |\"render API docs\"|FP\n",
" end\n",
" \n",
" FP -- modified json with only\\nQuarto directives remaining --> CF\n",
" \n",
" subgraph Quarto [\"&nbsp;<strong>Quarto</strong>\\n&nbsp;<br>\"]\n",
" direction LR\n",
" F[[_quarto.yml]] .-> G[[custom.yml]] & H[[sidebar.yml]]\n",
" class F,G,H files;\n",
" end\n",
" \n",
" QMD --\"rendered\\ndirectly by Quarto\\n(no pre-processing required)\"--> CF\n",
" CF --> Quarto\n",
" Quarto --> SS\n",
" \n",
" class NBP,CF,Quarto container;\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
38 changes: 0 additions & 38 deletions nbs/tutorials/tutorial.ipynb.off → nbs/tutorials/tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1499,44 +1499,6 @@
"### Quarto Features"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"nbdev supports most Quarto features. We encourage you to read the [Quarto documentation](https://quarto.org/) to discover all the features available to you. For example, this is how you can [incorporate mermaid charts](https://quarto.org/docs/authoring/diagrams.html):\n",
"\n",
"```{mermaid}\n",
"flowchart LR\n",
" A[Hard edge] --> B(Round edge)\n",
" B --> C{Decision}\n",
" C --> D[Result one]\n",
" C --> E[Result two]\n",
"```\n",
"\n",
"Here is another example of using [Graphviz](https://quarto.org/docs/authoring/diagrams.html#graphviz):\n",
"\n",
"```{dot}\n",
"graph G {\n",
" layout=neato\n",
" run -- intr;\n",
" intr -- runbl;\n",
" runbl -- run;\n",
" run -- kernel;\n",
" kernel -- zombie;\n",
" kernel -- sleep;\n",
" kernel -- runmem;\n",
" sleep -- swap;\n",
" swap -- runswap;\n",
" runswap -- new;\n",
" runswap -- runmem;\n",
" new -- runmem;\n",
" sleep -- runmem;\n",
"}\n",
"```\n",
"\n",
"It is worth taking a look at the documentation for [figures](https://quarto.org/docs/authoring/figures.html), [callouts](https://quarto.org/docs/authoring/callouts.html), [markdown](https://quarto.org/docs/authoring/markdown-basics.html), [widgets](https://quarto.org/docs/interactive/widgets/jupyter.html), [layouts](https://quarto.org/docs/interactive/layout.html), [conditional content](https://quarto.org/docs/authoring/conditional.html) and [quarto extensions](https://quarto.org/docs/extensions/) to name a few useful things we have encountered."
]
},
{
"cell_type": "code",
"execution_count": null,
Expand Down
Loading