Skip to content

Commit a4c7538

Browse files
authored
reorganize docs (#328)
* reorganize docs * update * checkpoint * checkpoint structure * src/democards fix * checkpoint fail pyplot * update fixes
1 parent bf8a84c commit a4c7538

File tree

14 files changed

+874
-777
lines changed

14 files changed

+874
-777
lines changed

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
11
Manifest.toml
2+
3+
# DemoCards
4+
generated/
5+
6+
docs/build/
7+
8+
work/
9+
site/
210
dev/

Project.toml

Lines changed: 0 additions & 15 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ The new documentation files will be pushed to the [`gh-pages`](https://github.co
99

1010
## Building the docs
1111

12-
With proper dependencies installed, run the following on your local terminal `$ GKSwstype=nul CI=true julia --project=docs docs/make.jl`.
12+
With proper dependencies installed, run the following on your local terminal `$ CI=true julia --project=docs docs/make.jl`.
1313

14-
Setting the environment variable `CI=true` is optional, but this will be closer to the remote docs building process.
14+
Setting the environment variable `CI=true` is optional, but the result will be closer to the remote docs building process.
15+
16+
To only build part of the documentation (faster dev), use `PLOTDOCS_BACKENDS='GR PyPlot'` and / or `PLOTDOCS_EXAMPLES='1 22 60'` environement variables.
1517

1618
## Contributing demos
1719

docs/.gitignore

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/Project.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
[deps]
22
AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
33
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
4+
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
45
DemoCards = "311a05b2-6137-4a5a-b473-18580a3d38b5"
56
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
67
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
78
FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
89
Gaston = "4b11ee91-296f-5714-9832-002c20994614"
910
GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
11+
Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
1012
GraphRecipes = "bd48cda9-67a9-57be-86fa-5b3c104eda73"
1113
Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
1214
ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19"
@@ -17,22 +19,24 @@ JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
1719
LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
1820
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
1921
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
22+
MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
2023
OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
24+
OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
2125
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
2226
PGFPlotsX = "8314cec4-20b6-5062-9cdb-752b83310925"
23-
PlotDocs = "16eed3e5-6057-5b33-8288-9339028cbc04"
2427
PlotThemes = "ccf2f8ad-2431-5c83-bf29-c5338b663b6a"
2528
PlotlyBase = "a03496cd-edff-5a9b-9e67-9cda94a718b5"
2629
PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
30+
PlotlyKaleido = "f2990250-8cf9-495f-b13a-cce12b45703c"
2731
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
2832
ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
2933
PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
34+
RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
3035
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
3136
RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
3237
RecipesPipeline = "01d81517-befc-4cb6-b9ec-a95719d0359c"
33-
RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
34-
StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
3538
SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
39+
StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
3640
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
3741
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
3842
StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"

docs/ci_build.sh

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,19 @@ sudo fc-cache -vr
4141
fc-list | grep 'JuliaMono'
4242

4343
echo "== install julia dependencies =="
44-
export JULIA_DEBUG='Documenter,PlotDocs,DemoCards'
45-
export DOCUMENTER_DEBUG=true # Democards.jl
44+
if true; then
45+
export JULIA_DEBUG='Documenter,Literate,DemoCards'
46+
export DOCUMENTER_DEBUG=true # Democards.jl
47+
fi
4648

4749
export GKSwstype=nul # Plots.jl/issues/3664
48-
export COLORTERM='truecolor' # UnicodePlots.jl
50+
export COLORTERM=truecolor # UnicodePlots.jl
4951
export PLOTDOCS_ANSICOLOR=true
5052

5153
julia='xvfb-run julia --color=yes --project=docs'
5254

5355
$julia -e '
54-
using Pkg
55-
Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()
56+
using Pkg; Pkg.instantiate()
5657
Pkg.add("Conda"); Pkg.build("Conda"; verbose=true)
5758
using Conda; env, rc = Conda.ROOTENV, Conda.conda_rc(Conda.ROOTENV)
5859
Conda.runconda(`config --set auto_update_conda False --file $rc --force`, env)
@@ -75,13 +76,9 @@ $julia -e '
7576
Pkg.add("PyCall"); Pkg.build("PyCall"; verbose=true)
7677
'
7778

78-
# tentative fix for `pyplot` bug: libstdc++.so.X: version `GLIBCXX_X.X.X' not found ...
79-
# export LD_PRELOAD=$(g++ --print-file-name=libstdc++.so)
80-
# export LD_PRELOAD=$($julia -e 'using Conda; joinpath(Conda.ROOTENV, "lib", "libstdc++.so") |> print')
81-
# echo $LD_PRELOAD
82-
8379
echo "== build documentation for $GITHUB_REPOSITORY@$GITHUB_REF, triggerd by $GITHUB_ACTOR on $GITHUB_EVENT_NAME =="
8480
if [ "$GITHUB_REPOSITORY" == 'JuliaPlots/PlotDocs.jl' ]; then
81+
$julia -e 'using Pkg; Pkg.add(PackageSpec(name="Plots", rev="master"))'
8582
$julia docs/make.jl
8683
elif [ "$GITHUB_REPOSITORY" == 'JuliaPlots/Plots.jl' ]; then
8784
$julia -e 'using Pkg; Pkg.add(PackageSpec(name="Plots", rev=split(ENV["GITHUB_REF"], "/", limit=3)[3])); Pkg.instantiate()'

0 commit comments

Comments
 (0)