You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,27 +5,35 @@ Documentation for [Plots.jl](https://github.com/JuliaPlots/Plots.jl)
5
5
## Editing the Docs
6
6
7
7
To edit the documentation, simply edit the Markdown files in [docs/src](https://github.com/JuliaPlots/PlotDocs.jl/tree/master/docs/src). [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) will automatically rebuild the documentation when changes are merged to master.
8
-
The new documentation files will be pushed to the [`gh-pages`](https://github.com/JuliaPlots/PlotDocs.jl/tree/gh-pages) branch in this repository (useful for debugging the `Plots.jl` documentation build through CI). When building new docs for a release (e.g. `1.Y.Z`), don't forget to manually delete the previous patch version in `gh-pages` (`1.Y.(Z - 1)`), thus avoiding filling up the deployment quota of `10Gb` imposed by `github`.
8
+
9
+
The new documentation files will be pushed to the [`gh-pages`](https://github.com/JuliaPlots/PlotDocs.jl/tree/gh-pages) branch in this repository (useful for debugging the `Plots.jl` documentation build through CI).
10
+
11
+
When building new docs for a release (e.g. `1.Y.Z`), don't forget to manually delete the previous patch version in `gh-pages` (`1.Y.(Z - 1)`), thus avoiding filling up the deployment quota of `10Gb` imposed by `github`.
9
12
10
13
## Building the docs
11
14
12
-
With proper dependencies installed, run the following on your local terminal `$ CI=true julia --project=docs docs/make.jl`.
15
+
With proper dependencies installed, run the following on your local terminal:
16
+
```bash
17
+
$ CI=true julia --project=docs docs/make.jl
18
+
```
13
19
14
20
Setting the environment variable `CI=true` is optional, but the result will be closer to the remote docs building process.
15
21
16
-
To only build part of the documentation (faster dev), use `PLOTDOCS_BACKENDS='GR PyPlot'` and / or `PLOTDOCS_EXAMPLES='1 22 60'` environement variables.
22
+
To only build part of the documentation (faster dev), use the following envionment variables:
23
+
-`PLOTDOCS_BACKENDS='GR PyPlot'` to select backends;
24
+
-`PLOTDOCS_EXAMPLES='1 22 60'` to select gallery examples.
17
25
18
26
## Contributing demos
19
27
20
28
The demos are valid julia scripts written with [Literate markup syntax][literate_syntax] and managed
21
29
by [DemoCards.jl][democards_jl]. The following steps shows a common workflow to add demos:
22
30
23
31
1. create your julia script in any sub-folder in `docs/user_gallery/`. For instance,
24
-
`docs/user_gallery/misc/gr_lorenz_attractor.jl`.
32
+
`docs/user_gallery/misc/gr_lorenz_attractor.jl`;
25
33
2. configure the demo using [DemoCards YAML frontmatter][yaml_frontmatter]. You may also check how
26
-
other demos are configured as a reference.
27
-
3. write the demo in Julia with the Literate markup syntax.
28
-
3. activate the docs environment and add `PlotDocs.jl` to the environment via `import Pkg; Pkg.activate("docs"); Pkg.develop(".")`
34
+
other demos are configured as a reference;
35
+
3. write the demo in Julia with the Literate markup syntax;
36
+
3. activate the docs environment and add `PlotDocs.jl` to the environment via `import Pkg; Pkg.activate("docs")`;
29
37
4. preview the demo using [`DemoCards.preview_demos` feature][democards_preview]. For instance, you
30
38
can partially build one single file via
31
39
`preview_demos("docs/user_gallery/misc/gr_lorenz_attractor.jl")`, or the entire section via
0 commit comments