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

Make the Quickstart docs a Pluto notebook #136

Merged
merged 51 commits into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
37439fd
Add Pluto as docs dependency
sethaxen Jun 12, 2021
c36402f
Add quickstart as Pluto notebook
sethaxen Jun 12, 2021
7d76964
Build notebook during docs
sethaxen Jun 12, 2021
0309436
Embed notebook as iframe
sethaxen Jun 12, 2021
805e5b7
Remove now-unused dependencies
sethaxen Jun 12, 2021
67733e9
Commit manifest
sethaxen Jun 12, 2021
e93d308
Update docs/notebooks/quickstart.jl
sethaxen Jun 12, 2021
1065e1a
Instantiate before dev
sethaxen Jun 12, 2021
f88ab2f
Increment version number
sethaxen Jun 12, 2021
de8b8b3
Build notebook in assets folder
sethaxen Jun 12, 2021
99cafd9
Revert "Build notebook in assets folder"
sethaxen Jun 12, 2021
081ab46
Correctly point to quickstart notebook
sethaxen Jun 12, 2021
375f434
Revert "Commit manifest"
sethaxen Jun 12, 2021
1bd2375
Revert "Instantiate before dev"
sethaxen Jun 12, 2021
8d04325
Use release Pluto
sethaxen Jun 12, 2021
d53a76e
Merge branch 'main' into plutoquickstart
sethaxen Mar 19, 2022
ba0a677
Update Soss examples in notebook
sethaxen Mar 19, 2022
8eba311
Run formatter
sethaxen Mar 19, 2022
a643629
Remove unneeded dependency
sethaxen Mar 19, 2022
abff15c
Remove unused docs dependencies
sethaxen Mar 19, 2022
18ffc79
Remove quickstart wrapper
sethaxen Mar 19, 2022
fc009c8
Move notebooks to src
sethaxen Mar 19, 2022
05458ae
Build quickstart with PlutoStaticHTML
sethaxen Mar 19, 2022
711b3b5
Run formatter
sethaxen Mar 19, 2022
45a2bfd
Allow piping syntax used by Soss
sethaxen Mar 19, 2022
91bbde7
Improvements to notebook formatting
sethaxen Mar 19, 2022
9dba5dd
Fix formatting
sethaxen Mar 19, 2022
3c6604c
Remove notebooks directory for now
sethaxen Mar 19, 2022
06400da
Add custom CSS
sethaxen Mar 20, 2022
001a8ac
Fix quickstart link
sethaxen Mar 20, 2022
d869e60
Add header links for backward compatibility
sethaxen Mar 20, 2022
4a96c73
Increment patch version
sethaxen Mar 20, 2022
4df9339
Improve top padding
sethaxen Mar 20, 2022
ba62432
Remove Pluto as dependency
sethaxen Mar 20, 2022
70717da
Use docs environment in notebook
sethaxen Mar 20, 2022
6e968cf
Add back PlutoStaticHTML as dependency
sethaxen Mar 20, 2022
ba1e66e
Use with_terminal
sethaxen Mar 20, 2022
c25fdc1
Add PlutoUI compat
sethaxen Mar 20, 2022
f3755f0
Merge branch 'main' into plutoquickstart
sethaxen Mar 20, 2022
c14c481
Increment patch version number
sethaxen Mar 20, 2022
23f1ba7
Load Pkg separately
sethaxen Mar 20, 2022
fd410b9
Merge branch 'main' into plutoquickstart
sethaxen Mar 20, 2022
3422620
Remove unused color information
sethaxen Mar 20, 2022
cf8a64e
Use post-1.6 simplified keyword syntax
sethaxen Mar 20, 2022
6f6c9dd
Merge branch 'main' into plutoquickstart
sethaxen Mar 23, 2022
280ef6c
Override PlutoStaticHTML's margin settings
sethaxen Mar 24, 2022
0110469
Increment patch version
sethaxen Mar 24, 2022
6fcf516
Add missing comma
sethaxen Mar 24, 2022
d42c3ab
Run formatter
sethaxen Mar 24, 2022
69a916d
Opt out of PlutoStaticHTML's custom css
sethaxen Mar 31, 2022
8136112
Improve admonition css
sethaxen Mar 31, 2022
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
13 changes: 5 additions & 8 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
[deps]
CmdStan = "593b3428-ca2f-500c-ae53-031589ec8ddd"
ArviZ = "131c737c-5715-5e2e-ad31-c244f01c1dc7"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DynamicPPL = "366bfd00-2699-11ea-058f-f148b4cae6d8"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
MCMCChains = "c7f686f2-ff18-58e9-bc7b-31028e88f75d"
Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0"
PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
SampleChains = "754583d1-7fc4-4dab-93b5-5eaca5c9622e"
SampleChainsDynamicHMC = "6d9fd711-e8b2-4778-9c70-c1dfb499d4c4"
Soss = "8ce77f84-9b61-11e8-39ff-d17a774bf41c"
Turing = "fce5fe82-541a-59a6-adf8-730c64b5f9a0"

[compat]
MCMCChains = "3.0, 4.0, 5.0"
Soss = "0.20"
Turing = "0.15, 0.16, 0.17, 0.18, 0.19"
PlutoStaticHTML = "4"
SampleChains = "0.5"
13 changes: 12 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
using Documenter, ArviZ
using MCMCChains: MCMCChains # make `from_mcmcchains` available for API docs
using SampleChains: SampleChains # make `from_samplechains` available for API docs
using PlutoStaticHTML: PlutoStaticHTML

const REL_NB_PATH = "notebooks"
const NB_PATH = joinpath(@__DIR__, "src", "notebooks")

# generate markdown from Pluto notebooks
output_format = PlutoStaticHTML.documenter_output
build_opts = PlutoStaticHTML.BuildOptions(
NB_PATH; previous_dir=NB_PATH, output_format=output_format
)
PlutoStaticHTML.build_notebooks(build_opts)

makedocs(;
modules=[ArviZ],
sitename="ArviZ.jl",
pages=[
"Home" => "index.md",
"Quickstart" => "quickstart.md",
"Quickstart" => joinpath(REL_NB_PATH, "quickstart.md"),
"API" => "api.md",
"Example Gallery" =>
["Matplotlib" => "mpl_examples.md", "Bokeh" => "bokeh_examples.md"],
Expand Down
Loading