Browse Source

Suggestion update of the links

pull/60/head
Benoit Pasquier 7 years ago committed by GitHub
parent
commit
037061d729
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      docs/src/customprocessing.md

10
docs/src/customprocessing.md

@ -95,7 +95,9 @@ Literate.markdown("examples.jl", "path/to/save/markdown"; @@ -95,7 +95,9 @@ Literate.markdown("examples.jl", "path/to/save/markdown";
and you will see that in the final output file (here `markdown_file_name.md`) the `include`
statements are replaced with the actual code to be included!
This approach is used for example in the documentation of the Julia package
[`TimeseriesPrediction`](https://github.com/JuliaDynamics/TimeseriesPrediction.jl),
see [~here~](https://github.com/JuliaDynamics/DynamicalSystems.jl/blob/master/docs/src/tsprediction/stexamples.jl)
and [here for the generating script](https://github.com/JuliaDynamics/DynamicalSystems.jl/blob/master/docs/make.jl#L11-L29)
This approach is used for generating [the examples](https://juliadynamics.github.io/TimeseriesPrediction.jl/latest/stexamples/)
in the documentation of the [TimeseriesPrediction.jl](https://github.com/JuliaDynamics/TimeseriesPrediction.jl) package.
The [example files](https://github.com/JuliaDynamics/TimeseriesPrediction.jl/tree/master/examples),
included together in the [stexamples.jl](https://github.com/JuliaDynamics/TimeseriesPrediction.jl/blob/master/docs/src/stexamples.jl) file,
are processed by literate via this [make.jl](https://github.com/JuliaDynamics/TimeseriesPrediction.jl/blob/master/docs/make.jl) file to generate the markdown and code cells of the documentation.

Loading…
Cancel
Save