diff --git a/dev/assets/documenter.css b/dev/assets/documenter.css
index 26c8166..7cd2662 100644
--- a/dev/assets/documenter.css
+++ b/dev/assets/documenter.css
@@ -170,8 +170,10 @@ nav.toc {
left: 0;
bottom: 0;
width: 20em;
+ display: flex;
+ flex-flow: column nowrap;
overflow-y: auto;
- padding: 1em 0;
+ padding: 1em 0 0 0;
background-color: #fcfcfc;
box-shadow: inset -14px 0px 5px -12px rgb(210,210,210);
}
@@ -192,6 +194,7 @@ nav.toc h1 {
nav.toc select {
display: block;
height: 2em;
+ flex-shrink: 0;
padding: 0 1.6em 0 1em;
min-width: 7em;
max-width: 90%;
@@ -239,6 +242,16 @@ nav.toc > ul * {
margin: 0;
}
+nav.toc > ul {
+ min-height: 2em;
+ overflow-y: auto;
+ margin: 0;
+}
+
+nav.toc > ul > li:last-child {
+ padding-bottom: 1em;
+}
+
nav.toc ul {
color: #404040;
padding: 0;
@@ -305,6 +318,21 @@ nav.toc li.current > .toctext {
background-color: white;
}
+nav.toc ul::-webkit-scrollbar {
+ width: .4em;
+ background: none;
+}
+
+nav.toc ul::-webkit-scrollbar-thumb {
+ border-radius: 5px;
+ background: #c9c9c9;
+}
+
+nav.toc ul::-webkit-scrollbar-thumb:hover {
+ border-radius: 5px;
+ background: #aaaaaa;
+}
+
article {
margin-left: 20em;
min-width: 20em;
@@ -398,6 +426,7 @@ article section.docstring a.source-link {
.admonition {
border-radius: 3px;
background-color: #eeeeee;
+ margin: 1em 0;
}
.admonition-title {
@@ -473,7 +502,6 @@ article section.docstring a.source-link {
@media only screen and (max-width: 768px) {
nav.toc {
position: fixed;
- overflow-y: scroll;
width: 16em;
left: -16em;
-webkit-overflow-scrolling: touch;
@@ -484,6 +512,7 @@ article section.docstring a.source-link {
-webkit-transition-timing-function: ease-out; /* Safari */
transition-timing-function: ease-out;
z-index: 2;
+ box-shadow: 5px 0px 5px 0px rgb(210,210,210);
}
nav.toc.show {
@@ -531,7 +560,6 @@ article section.docstring a.source-link {
}
article > header div#topbar span {
- position: fixed;
width: 80%;
height: 1.5em;
margin-top: -0.1em;
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js
index 5d31622..761ae29 100644
--- a/dev/assets/documenter.js
+++ b/dev/assets/documenter.js
@@ -94,6 +94,9 @@ require(['jquery'], function($) {
if ($('#version-selector > option').length > 0) {
version_selector.css("visibility", "visible");
}
+
+ // Scroll the navigation bar to the currently selected menu item
+ $("nav.toc > ul").get(0).scrollTop = $(".current").get(0).offsetTop - $("nav.toc > ul").get(0).offsetTop;
})
})
diff --git a/dev/customprocessing.html b/dev/customprocessing.html
deleted file mode 100644
index 9253605..0000000
--- a/dev/customprocessing.html
+++ /dev/null
@@ -1,29 +0,0 @@
-
-5. Custom pre- and post-processing · Literate.jl Literate.jl Since all packages are different, and may have different demands on how to create a nice example for the documentation it is important that the package maintainer does not feel limited by the by default provided syntax that this package offers. While you can generally come a long way by utilizing line filtering there might be situations where you need to manually hook into the generation and change things. In Literate this is done by letting the user supply custom pre- and post-processing functions that may do transformation of the content.
All of the generators (Literate.markdownLiterate.notebookLiterate.scriptpreprocess and postprocess keyword arguments. The default "transformation" is the identity function. The input to the transformation functions is a String, and the output should be the transformed String.
preprocess is sent the raw input that is read from the source file (modulo the default line ending transformation ). postprocess is given different things depending on the output: For markdown and script output postprocess is given the content String just before writing it to the output file, but for notebook output postprocess is given the dictionary representing the notebook, since, in general, this is more useful.
As an example, lets say we want to splice the date of generation into the output. We could of course update our source file before generating the docs, but we could instead use a preprocess function that splices the date into the source for us. Consider the following source file:
# # Example
-# This example was generated DATEOFTODAY
-
-x = 1 // 3where DATEOFTODAY is a placeholder, to make it easier for our preprocess function to find the location. Now, lets define the preprocess function, for example
function update_date(content)
- content = replace(content, "DATEOFTODAY" => Date(now()))
- return content
-endwhich would replace every occurrence of "DATEOFTODAY" with the current date. We would now simply give this function to the generator, for example:
Literate.markdown("input.jl", "outputdir"; preprocess = update_date)Let's say that we have some individual example files file1, file2, ... etc. that are runnable and also following the style of Literate. These files could be for example used in the test suite of your package.
We want to group them all into a single page in our documentation, but we do not want to copy paste the content of file1, ... for robustness: the files are included in the test suite and some changes may occur to them. We want these changes to also be reflected in the documentation.
A very easy way to do this is using preprocess to interchange include statements with file content. First, create a runnable .jl following the format of Literate
# # Replace includes
-# This is an example to replace `include` calls with the actual file content.
-
-include("file1.jl")
-
-# Cool, we just saw the result of the above code snippet. Here is one more:
-
-include("file2.jl")Let's say we have saved this file as examples.jl. Then, you want to properly define a pre-processing function:
function replace_includes(str)
-
- included = ["file1.jl", "file2.jl"]
-
- # Here the path loads the files from their proper directory,
- # which may not be the directory of the `examples.jl` file!
- path = "directory/to/example/files/"
-
- for ex in included
- content = read(path*ex, String)
- str = replace(str, "include(\"$(ex)\")" => content)
- end
- return str
-end(of course replace included with your respective files)
Finally, you simply pass this function to e.g. Literate.markdown
Literate.markdown("examples.jl", "path/to/save/markdown";
- name = "markdown_file_name", preprocess = replace_includes)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 TimeseriesPredictionhere and here for the generating script
5. Custom pre- and post-processing · Literate.jl Literate.jl Since all packages are different, and may have different demands on how to create a nice example for the documentation it is important that the package maintainer does not feel limited by the by default provided syntax that this package offers. While you can generally come a long way by utilizing line filtering there might be situations where you need to manually hook into the generation and change things. In Literate this is done by letting the user supply custom pre- and post-processing functions that may do transformation of the content.
All of the generators (Literate.markdownLiterate.notebookLiterate.scriptpreprocess and postprocess keyword arguments. The default "transformation" is the identity function. The input to the transformation functions is a String, and the output should be the transformed String.
preprocess is sent the raw input that is read from the source file (modulo the default line ending transformation ). postprocess is given different things depending on the output: For markdown and script output postprocess is given the content String just before writing it to the output file, but for notebook output postprocess is given the dictionary representing the notebook, since, in general, this is more useful.
As an example, lets say we want to splice the date of generation into the output. We could of course update our source file before generating the docs, but we could instead use a preprocess function that splices the date into the source for us. Consider the following source file:
# # Example
+# This example was generated DATEOFTODAY
+
+x = 1 // 3where DATEOFTODAY is a placeholder, to make it easier for our preprocess function to find the location. Now, lets define the preprocess function, for example
function update_date(content)
+ content = replace(content, "DATEOFTODAY" => Date(now()))
+ return content
+endwhich would replace every occurrence of "DATEOFTODAY" with the current date. We would now simply give this function to the generator, for example:
Literate.markdown("input.jl", "outputdir"; preprocess = update_date)Let's say that we have some individual example files file1, file2, ... etc. that are runnable and also following the style of Literate. These files could be for example used in the test suite of your package.
We want to group them all into a single page in our documentation, but we do not want to copy paste the content of file1, ... for robustness: the files are included in the test suite and some changes may occur to them. We want these changes to also be reflected in the documentation.
A very easy way to do this is using preprocess to interchange include statements with file content. First, create a runnable .jl following the format of Literate
# # Replace includes
+# This is an example to replace `include` calls with the actual file content.
+
+include("file1.jl")
+
+# Cool, we just saw the result of the above code snippet. Here is one more:
+
+include("file2.jl")Let's say we have saved this file as examples.jl. Then, you want to properly define a pre-processing function:
function replace_includes(str)
+
+ included = ["file1.jl", "file2.jl"]
+
+ # Here the path loads the files from their proper directory,
+ # which may not be the directory of the `examples.jl` file!
+ path = "directory/to/example/files/"
+
+ for ex in included
+ content = read(path*ex, String)
+ str = replace(str, "include(\"$(ex)\")" => content)
+ end
+ return str
+end(of course replace included with your respective files)
Finally, you simply pass this function to e.g. Literate.markdown
Literate.markdown("examples.jl", "path/to/save/markdown";
+ name = "markdown_file_name", preprocess = replace_includes)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 TimeseriesPredictionhere and here for the generating script
6. Interaction with Documenter.jl · Literate.jl Literate.jl Literate can be used for any purpose, it spits out regular markdown files, and notebooks. Typically, though, these files will be used to render documentation for your package. The generators (Literate.markdownLiterate.notebookLiterate.scriptdocumenter that lets the generator perform some extra things, keeping in mind that the source code have been written with Documenter.jl in mind. So lets take a look at what will happen if we set documenter = true:
Documenter style @refs and @id will be removed. This means that you can use @ref and @id in the source file without them leaking to the script. 6. Interaction with Documenter.jl · Literate.jl Literate.jl Literate can be used for any purpose, it spits out regular markdown files, and notebooks. Typically, though, these files will be used to render documentation for your package. The generators (Literate.markdownLiterate.notebookLiterate.scriptdocumenter that lets the generator perform some extra things, keeping in mind that the source code have been written with Documenter.jl in mind. So lets take a look at what will happen if we set documenter = true:
Documenter style @refs and @id will be removed. This means that you can use @ref and @id in the source file without them leaking to the script. 2. File Format · Literate.jl Literate.jl The source file format for Literate is a regular, commented, julia (.jl) scripts. The idea is that the scripts also serve as documentation on their own and it is also simple to include them in the test-suite, with e.g. include, to make sure the examples stay up do date with other changes in your package.
The basic syntax is simple:
lines starting with # are treated as markdown, all other lines are treated as julia code. Leading whitespace is allowed before #, but it will be removed when generating the output. Since #-lines is treated as markdown we can not use that for regular julia comments, for this you can instead use ##, which will render as # in the output.
Lets look at a simple example:
# # Rational numbers
-#
-# In julia rational numbers can be constructed with the `//` operator.
-# Lets define two rational numbers, `x` and `y`:
-
-x = 1//3
-y = 2//5
-
-# When adding `x` and `y` together we obtain a new rational number:
-
-z = x + yIn the lines starting with # we can use regular markdown syntax, for example the # used for the heading and the backticks for formatting code. The other lines are regular julia code. We note a couple of things:
The script is valid julia, which means that we can include it and the example will run (for example in the test/runtests.jl script, to include the example in the test suite). The script is "self-explanatory", i.e. the markdown lines works as comments and thus serve as good documentation on its own. For simple use this is all you need to know. The following additional special syntax can also be used:
There is also some default convenience replacements that will always be performed, see Default Replacements .
It is often useful to filter out lines in the source depending on the output format. For this purpose there are a number of "tokens" that can be used to mark the purpose of certain lines:
#md: line exclusive to markdown output,#nb: line exclusive to notebook output,#jl: line exclusive to script output,#src: line exclusive to the source code and thus filtered out unconditionally.Lines starting with one of these tokens are filtered out in the preprocessing step .
Suppose, for example, that we want to include a docstring within a @docs block using Documenter. Obviously we don't want to include this in the notebook, since @docs is Documenter syntax that the notebook will not understand. This is a case where we can prepend #md to those lines:
#md # ```@docs
-#md # Literate.markdown
-#md # Literate.notebook
-#md # Literate.markdown
-#md # ```The lines in the example above would be filtered out in the preprocessing step, unless we are generating a markdown file. When generating a markdown file we would simple remove the leading #md from the lines. Beware that the space after the tag is also removed.
The #src token can also be placed at the end of a line. This is to make it possible to have code lines exclusive to the source code, and not just comment lines. For example, if the source file is included in the test suite we might want to add a @test at the end without this showing up in the outputs:
using Test #src
-@test result == expected_result #srcThe following convenience "macros" are always expanded:
@__NAME__
expands to the name keyword argument to Literate.markdownLiterate.notebookLiterate.script
@__REPO__ROOT_URL__
expands to https://github.com/$(ENV["TRAVIS_REPO_SLUG"])/blob/master/ and is a convenient way to use when you want to link to files outside the doc-build directory. For example @__REPO__ROOT_URL__src/Literate.jl would link to the source of the Literate module.
@__NBVIEWER_ROOT_URL__
expands to https://nbviewer.jupyter.org/github/$(ENV["TRAVIS_REPO_SLUG"])/blob/gh-pages/$(folder)/ where folder is the folder that Documenter.deploydocs deploys too. This can be used if you want a link that opens the generated notebook in http://nbviewer.jupyter.org/ .
2. File Format · Literate.jl Literate.jl The source file format for Literate is a regular, commented, julia (.jl) scripts. The idea is that the scripts also serve as documentation on their own and it is also simple to include them in the test-suite, with e.g. include, to make sure the examples stay up do date with other changes in your package.
The basic syntax is simple:
lines starting with # are treated as markdown, all other lines are treated as julia code. Leading whitespace is allowed before #, but it will be removed when generating the output. Since #-lines is treated as markdown we can not use that for regular julia comments, for this you can instead use ##, which will render as # in the output.
Lets look at a simple example:
# # Rational numbers
+#
+# In julia rational numbers can be constructed with the `//` operator.
+# Lets define two rational numbers, `x` and `y`:
+
+x = 1//3
+y = 2//5
+
+# When adding `x` and `y` together we obtain a new rational number:
+
+z = x + yIn the lines starting with # we can use regular markdown syntax, for example the # used for the heading and the backticks for formatting code. The other lines are regular julia code. We note a couple of things:
The script is valid julia, which means that we can include it and the example will run (for example in the test/runtests.jl script, to include the example in the test suite). The script is "self-explanatory", i.e. the markdown lines works as comments and thus serve as good documentation on its own. For simple use this is all you need to know. The following additional special syntax can also be used:
There is also some default convenience replacements that will always be performed, see Default Replacements .
It is often useful to filter out lines in the source depending on the output format. For this purpose there are a number of "tokens" that can be used to mark the purpose of certain lines:
#md: line exclusive to markdown output,#nb: line exclusive to notebook output,#jl: line exclusive to script output,#src: line exclusive to the source code and thus filtered out unconditionally.Lines starting with one of these tokens are filtered out in the preprocessing step .
Suppose, for example, that we want to include a docstring within a @docs block using Documenter. Obviously we don't want to include this in the notebook, since @docs is Documenter syntax that the notebook will not understand. This is a case where we can prepend #md to those lines:
#md # ```@docs
+#md # Literate.markdown
+#md # Literate.notebook
+#md # Literate.markdown
+#md # ```The lines in the example above would be filtered out in the preprocessing step, unless we are generating a markdown file. When generating a markdown file we would simple remove the leading #md from the lines. Beware that the space after the tag is also removed.
The #src token can also be placed at the end of a line. This is to make it possible to have code lines exclusive to the source code, and not just comment lines. For example, if the source file is included in the test suite we might want to add a @test at the end without this showing up in the outputs:
using Test #src
+@test result == expected_result #srcThe following convenience "macros" are always expanded:
@__NAME__
expands to the name keyword argument to Literate.markdownLiterate.notebookLiterate.script
@__REPO__ROOT_URL__
expands to https://github.com/$(ENV["TRAVIS_REPO_SLUG"])/blob/master/ and is a convenient way to use when you want to link to files outside the doc-build directory. For example @__REPO__ROOT_URL__src/Literate.jl would link to the source of the Literate module.
@__NBVIEWER_ROOT_URL__
expands to https://nbviewer.jupyter.org/github/$(ENV["TRAVIS_REPO_SLUG"])/blob/gh-pages/$(folder)/ where folder is the folder that Documenter.deploydocs deploys too. This can be used if you want a link that opens the generated notebook in http://nbviewer.jupyter.org/ .
7. Example · Literate.jl Literate.jl This is an example generated with Literate based on this source file: example.jlexample.ipynbexample.jl
It is recommended to have the source file available when reading this, to better understand how the syntax in the source file corresponds to the output you are seeing.
The basic syntax for Literate is simple, lines starting with # is interpreted as markdown, and all the other lines are interpreted as code. Here is some code:
In markdown sections we can use markdown syntax. For example, we can write text in italic font , text in bold font and use links .
It is possible to filter out lines depending on the output using the #md, #nb, #jl and #src tags (see Filtering Lines ):
This line starts with #md and is thus only visible in the markdown output. The source file is parsed in chunks of markdown and code. Starting a line with #- manually inserts a chunk break. For example, if we want to display the output of the following operations we may insert #- in between. These two code blocks will now end up in different @example-blocks in the markdown output, and two different notebook cells in the notebook output.
Code chunks are by default placed in Documenter @example blocks in the generated markdown. This means that the output will be captured in a block when Documenter is building the docs. In notebooks the output is captured in output cells, if the execute keyword argument is set to true. Output to stdout/stderr is also captured.
function foo()
- println("This string is printed to stdout.")
- return [1, 2, 3, 4]
-end
-
-foo()This string is printed to stdout.
-4-element Array{Int64,1}:
- 1
- 2
- 3
- 4Both Documenter's @example block and notebooks can display images. Here is an example where we generate a simple plot using the Plots.jl package
using Plots
-x = range(0, stop=6π, length=1000)
-y1 = sin.(x)
-y2 = cos.(x)
-plot(x, [y1, y2])
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-0
-
-
-5
-
-
-10
-
-
-15
-
-
--1.0
-
-
--0.5
-
-
-0.0
-
-
-0.5
-
-
-1.0
-
-
-y1
-
-
-y2
-
-
-
It is possible to give Literate custom pre- and post-processing functions. For example, here we insert two placeholders, which we will replace with something else at time of generation. We have here replaced our placeholders with z and 1.0 + 2.0im:
z = 1.0 + 2.0im1.0 + 2.0imIn the source file it is possible to use Documenter.jl style references, such as @ref and @id. These will be filtered out in the notebook output. For example, here is a link , but it is only visible as a link if you are reading the markdown output. We can also use equations:
\[\int_\Omega \nabla v \cdot \nabla u\ \mathrm{d}\Omega = \int_\Omega v f\ \mathrm{d}\Omega\]
using Documenters math syntax. Documenters syntax is automatically changed to \begin{equation} ... \end{equation} in the notebook output to display correctly.
This page was generated using Literate.jl .
\n",
+ "\n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
+ " \n",
+ " \n",
+ " \n",
+ "\n",
+ "\n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
- "0 \n",
+ "\n",
+ "0 \n",
" \n",
- "\n",
- "5 \n",
+ "\n",
+ "5 \n",
" \n",
- "\n",
- "10 \n",
+ "\n",
+ "10 \n",
" \n",
- "\n",
- "15 \n",
+ "\n",
+ "15 \n",
" \n",
- "\n",
- "-1.0 \n",
+ "\n",
+ "-1.0 \n",
" \n",
- "\n",
- "-0.5 \n",
+ "\n",
+ "-0.5 \n",
" \n",
- "\n",
- "0.0 \n",
+ "\n",
+ "0.0 \n",
" \n",
- "\n",
- "0.5 \n",
+ "\n",
+ "0.5 \n",
" \n",
- "\n",
- "1.0 \n",
+ "\n",
+ "1.0 \n",
" \n",
- "\n",
- "\n",
- "y1 \n",
+ "\n",
+ "y1 \n",
" \n",
- "\n",
- "y2 \n",
+ "\n",
+ "y2 \n",
" \n",
" \n"
],
"image/svg+xml": [
"\n",
- "\n",
+ "\n",
+ "\n",
+ " \n",
+ " \n",
+ " \n",
+ " \n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
"\n",
- " \n",
- " \n",
+ " \n",
+ " \n",
" \n",
" \n",
- "\n",
- "0 \n",
+ "\n",
+ "0 \n",
" \n",
- "\n",
- "5 \n",
+ "\n",
+ "5 \n",
" \n",
- "\n",
- "10 \n",
+ "\n",
+ "10 \n",
" \n",
- "\n",
- "15 \n",
+ "\n",
+ "15 \n",
" \n",
- "\n",
- "-1.0 \n",
+ "\n",
+ "-1.0 \n",
" \n",
- "\n",
- "-0.5 \n",
+ "\n",
+ "-0.5 \n",
" \n",
- "\n",
- "0.0 \n",
+ "\n",
+ "0.0 \n",
" \n",
- "\n",
- "0.5 \n",
+ "\n",
+ "0.5 \n",
" \n",
- "\n",
- "1.0 \n",
+ "\n",
+ "1.0 \n",
" \n",
- "\n",
- "\n",
- "y1 \n",
+ "\n",
+ "y1 \n",
" \n",
- "\n",
- "y2 \n",
+ "\n",
+ "y2 \n",
" \n",
" \n"
]
diff --git a/dev/generated/example/index.html b/dev/generated/example/index.html
new file mode 100644
index 0000000..d2316bf
--- /dev/null
+++ b/dev/generated/example/index.html
@@ -0,0 +1,357 @@
+
+7. Example · Literate.jl Literate.jl This is an example generated with Literate based on this source file: example.jlexample.ipynbexample.jl
It is recommended to have the source file available when reading this, to better understand how the syntax in the source file corresponds to the output you are seeing.
The basic syntax for Literate is simple, lines starting with # is interpreted as markdown, and all the other lines are interpreted as code. Here is some code:
In markdown sections we can use markdown syntax. For example, we can write text in italic font , text in bold font and use links .
It is possible to filter out lines depending on the output using the #md, #nb, #jl and #src tags (see Filtering Lines ):
This line starts with #md and is thus only visible in the markdown output. The source file is parsed in chunks of markdown and code. Starting a line with #- manually inserts a chunk break. For example, if we want to display the output of the following operations we may insert #- in between. These two code blocks will now end up in different @example-blocks in the markdown output, and two different notebook cells in the notebook output.
Code chunks are by default placed in Documenter @example blocks in the generated markdown. This means that the output will be captured in a block when Documenter is building the docs. In notebooks the output is captured in output cells, if the execute keyword argument is set to true. Output to stdout/stderr is also captured.
function foo()
+ println("This string is printed to stdout.")
+ return [1, 2, 3, 4]
+end
+
+foo()This string is printed to stdout.
+4-element Array{Int64,1}:
+ 1
+ 2
+ 3
+ 4Both Documenter's @example block and notebooks can display images. Here is an example where we generate a simple plot using the Plots.jl package
using Plots
+x = range(0, stop=6π, length=1000)
+y1 = sin.(x)
+y2 = cos.(x)
+plot(x, [y1, y2])
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+0
+
+
+5
+
+
+10
+
+
+15
+
+
+-1.0
+
+
+-0.5
+
+
+0.0
+
+
+0.5
+
+
+1.0
+
+
+y1
+
+
+y2
+
+
+
It is possible to give Literate custom pre- and post-processing functions. For example, here we insert two placeholders, which we will replace with something else at time of generation. We have here replaced our placeholders with z and 1.0 + 2.0im:
z = 1.0 + 2.0im1.0 + 2.0imIn the source file it is possible to use Documenter.jl style references, such as @ref and @id. These will be filtered out in the notebook output. For example, here is a link , but it is only visible as a link if you are reading the markdown output. We can also use equations:
\[\int_\Omega \nabla v \cdot \nabla u\ \mathrm{d}\Omega = \int_\Omega v f\ \mathrm{d}\Omega\]
using Documenters math syntax. Documenters syntax is automatically changed to \begin{equation} ... \end{equation} in the notebook output to display correctly.
This page was generated using Literate.jl .
1. Introduction · Literate.jl Literate.jl Welcome to the documentation for Literate – a simplistic package for Literate Programming .
Literate is a package that generates markdown pages (for e.g. Documenter.jl ), and Jupyter notebooks , from the same source file. There is also an option to "clean" the source from all metadata, and produce a pure Julia script.
The main design goal is simplicity. It should be simple to use, and the syntax should be simple. In short, all you have to do is to write a commented julia script!
The public interface consists mainly of three functions, all of which take the same script file as input, but generate different output:
Examples are (probably) the best way to showcase your awesome package, and examples are often the best way for a new user to learn how to use it. It is therefore important that the documentation of your package contains examples for users to read and study. However, people are different, and we all prefer different ways of trying out a new package. Some people wants to RTFM, others want to explore the package interactively in, for example, a notebook, and some people wants to study the source code. The aim of Literate is to make it easy to give the user all of these options, while still keeping maintenance to a minimum.
It is quite common that packages have "example notebooks" to showcase the package. Notebooks are great for showcasing a package, but they are not so great with version control, like git. The reason being that a notebook is a very "rich" format since it contains output and other metadata. Changes to the notebook thus result in large diffs, which makes it harder to review the actual changes.
It is also common that packages include examples in the documentation, for example by using Documenter.jl @example-blocks. This is also great, but it is not quite as interactive as a notebook, for the users who prefer that.
Literate tries to solve the problems above by creating the output as a part of the doc build. Literate generates the output based on a single source file which makes it easier to maintain, test, and keep the manual and your example notebooks in sync.
1. Introduction · Literate.jl Literate.jl Welcome to the documentation for Literate – a simplistic package for Literate Programming .
Literate is a package that generates markdown pages (for e.g. Documenter.jl ), and Jupyter notebooks , from the same source file. There is also an option to "clean" the source from all metadata, and produce a pure Julia script.
The main design goal is simplicity. It should be simple to use, and the syntax should be simple. In short, all you have to do is to write a commented julia script!
The public interface consists mainly of three functions, all of which take the same script file as input, but generate different output:
Examples are (probably) the best way to showcase your awesome package, and examples are often the best way for a new user to learn how to use it. It is therefore important that the documentation of your package contains examples for users to read and study. However, people are different, and we all prefer different ways of trying out a new package. Some people wants to RTFM, others want to explore the package interactively in, for example, a notebook, and some people wants to study the source code. The aim of Literate is to make it easy to give the user all of these options, while still keeping maintenance to a minimum.
It is quite common that packages have "example notebooks" to showcase the package. Notebooks are great for showcasing a package, but they are not so great with version control, like git. The reason being that a notebook is a very "rich" format since it contains output and other metadata. Changes to the notebook thus result in large diffs, which makes it harder to review the actual changes.
It is also common that packages include examples in the documentation, for example by using Documenter.jl @example-blocks. This is also great, but it is not quite as interactive as a notebook, for the users who prefer that.
Literate tries to solve the problems above by creating the output as a part of the doc build. Literate generates the output based on a single source file which makes it easier to maintain, test, and keep the manual and your example notebooks in sync.
4. Output Formats · Literate.jl Literate.jl When the source is parsed, and have been processed it is time to render the output. We will consider the following source snippet:
# # Rational numbers
-#
-# In julia rational numbers can be constructed with the `//` operator.
-# Lets define two rational numbers, `x` and `y`:
-
-x = 1//3
-#-
-y = 2//5
-
-# When adding `x` and `y` together we obtain a new rational number:
-
-z = x + yand see how this is rendered in each of the output formats.
The (default) markdown output of the source snippet above is as follows
```@meta
-EditURL = "https://github.com/fredrikekre/Literate.jl/blob/master/docs/src/outputformats.jl"
-```
-
-# Rational numbers
-
-In julia rational numbers can be constructed with the `//` operator.
-Lets define two rational numbers, `x` and `y`:
-
-```@example name
-x = 1//3
-```
-
-```@example name
-y = 2//5
-```
-
-When adding `x` and `y` together we obtain a new rational number:
-
-```@example name
-z = x + y
-```We note that lines starting with # are printed as regular markdown, and the code lines have been wrapped in @example blocks. We also note that an @meta block have been added, that sets the EditURL variable. This is used by Documenter to redirect the "Edit on GitHub" link for the page, see Interaction with Documenter .
Some of the output rendering can be controlled with keyword arguments to Literate.markdown
Literate.markdown(inputfile, outputdir; kwargs...)Generate a markdown file from inputfile and write the result to the directoryoutputdir.
Keyword arguments:
source The (default) notebook output of the source snippet can be seen here: notebook.ipynb .
We note that lines starting with # are placed in markdown cells, and the code lines have been placed in code cells. By default the notebook is also executed and output cells populated. The current working directory is set to the specified output directory the notebook is executed. Some of the output rendering can be controlled with keyword arguments to Literate.notebook
Literate.notebook(inputfile, outputdir; kwargs...)Generate a notebook from inputfile and write the result to outputdir.
Keyword arguments:
name: name of the output file, excluding .ipynb. name is also used to replace @__NAME__. Defaults to the filename of inputfile.preprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.execute: a boolean deciding if the generated notebook should also be executed or not. Defaults to true. The current working directory is set to outputdir when executing the notebook.documenter: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to true. See the the manual section on Interaction with Documenter .credit: boolean that controls the addition of This file was generated with Literate.jl ... to the bottom of the page. If you find Literate.jl useful then feel free to keep this to the default, which is true.source The (default) script output of the source snippet above is as follows
x = 1//3
-
-y = 2//5
-
-z = x + yWe note that lines starting with # are removed and only the code lines have been kept. Some of the output rendering can be controlled with keyword arguments to Literate.script
Literate.script(inputfile, outputdir; kwargs...)Generate a plain script file from inputfile and write the result to outputdir.
Keyword arguments:
name: name of the output file, excluding .jl. name is also used to replace @__NAME__. Defaults to the filename of inputfile.preprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.documenter: boolean that says if the source contains Documenter.jl specific things to filter out during script generation. Defaults to true. See the the manual section on Interaction with Documenter .keep_comments: boolean that, if set to true, keeps markdown lines as comments in the output script. Defaults to false.credit: boolean that controls the addition of This file was generated with Literate.jl ... to the bottom of the page. If you find Literate.jl useful then feel free to keep this to the default, which is true.source 4. Output Formats · Literate.jl Literate.jl When the source is parsed, and have been processed it is time to render the output. We will consider the following source snippet:
# # Rational numbers
+#
+# In julia rational numbers can be constructed with the `//` operator.
+# Lets define two rational numbers, `x` and `y`:
+
+x = 1//3
+#-
+y = 2//5
+
+# When adding `x` and `y` together we obtain a new rational number:
+
+z = x + yand see how this is rendered in each of the output formats.
The (default) markdown output of the source snippet above is as follows
```@meta
+EditURL = "https://github.com/fredrikekre/Literate.jl/blob/master/docs/src/outputformats.jl"
+```
+
+# Rational numbers
+
+In julia rational numbers can be constructed with the `//` operator.
+Lets define two rational numbers, `x` and `y`:
+
+```@example name
+x = 1//3
+```
+
+```@example name
+y = 2//5
+```
+
+When adding `x` and `y` together we obtain a new rational number:
+
+```@example name
+z = x + y
+```We note that lines starting with # are printed as regular markdown, and the code lines have been wrapped in @example blocks. We also note that an @meta block have been added, that sets the EditURL variable. This is used by Documenter to redirect the "Edit on GitHub" link for the page, see Interaction with Documenter .
Some of the output rendering can be controlled with keyword arguments to Literate.markdown
Literate.markdown(inputfile, outputdir; kwargs...)Generate a markdown file from inputfile and write the result to the directoryoutputdir.
Keyword arguments:
source The (default) notebook output of the source snippet can be seen here: notebook.ipynb .
We note that lines starting with # are placed in markdown cells, and the code lines have been placed in code cells. By default the notebook is also executed and output cells populated. The current working directory is set to the specified output directory the notebook is executed. Some of the output rendering can be controlled with keyword arguments to Literate.notebook
Literate.notebook(inputfile, outputdir; kwargs...)Generate a notebook from inputfile and write the result to outputdir.
Keyword arguments:
name: name of the output file, excluding .ipynb. name is also used to replace @__NAME__. Defaults to the filename of inputfile.preprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.execute: a boolean deciding if the generated notebook should also be executed or not. Defaults to true. The current working directory is set to outputdir when executing the notebook.documenter: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to true. See the the manual section on Interaction with Documenter .credit: boolean that controls the addition of This file was generated with Literate.jl ... to the bottom of the page. If you find Literate.jl useful then feel free to keep this to the default, which is true.source The (default) script output of the source snippet above is as follows
x = 1//3
+
+y = 2//5
+
+z = x + yWe note that lines starting with # are removed and only the code lines have been kept. Some of the output rendering can be controlled with keyword arguments to Literate.script
Literate.script(inputfile, outputdir; kwargs...)Generate a plain script file from inputfile and write the result to outputdir.
Keyword arguments:
name: name of the output file, excluding .jl. name is also used to replace @__NAME__. Defaults to the filename of inputfile.preprocess, postprocess: custom pre- and post-processing functions, see the Custom pre- and post-processing section of the manual. Defaults to identity.documenter: boolean that says if the source contains Documenter.jl specific things to filter out during script generation. Defaults to true. See the the manual section on Interaction with Documenter .keep_comments: boolean that, if set to true, keeps markdown lines as comments in the output script. Defaults to false.credit: boolean that controls the addition of This file was generated with Literate.jl ... to the bottom of the page. If you find Literate.jl useful then feel free to keep this to the default, which is true.source 3. Processing pipeline · Literate.jl Literate.jl The generation of output follows the same pipeline for all output formats:
Pre-processing Parsing Document generation Post-processing Writing to file The first step is pre-processing of the input file. The file is read to a String. The first processing step is to apply the user specified pre-processing function, see Custom pre- and post-processing .
The next step is to perform all of the built-in default replacements. CRLF style line endings ("\r\n") are replaced with LF line endings ("\n") to simplify internal processing. Next, line filtering is performed, see Filtering Lines , meaning that lines starting with #md, #nb or #jl are handled (either just the token itself is removed, or the full line, depending on the output target). The last pre-processing step is to expand the convenience "macros" described in Default Replacements is expanded.
After the preprocessing the file is parsed. The first step is to categorize each line and mark them as either markdown or code according to the rules described in the Syntax section. Lets consider the example from the previous section with each line categorized:
# # Rational numbers <- markdown
-# <- markdown
-# In julia rational numbers can be constructed with the `//` operator. <- markdown
-# Lets define two rational numbers, `x` and `y`: <- markdown
- <- code
-x = 1 // 3 <- code
-y = 2 // 5 <- code
- <- code
-# When adding `x` and `y` together we obtain a new rational number: <- markdown
- <- code
-z = x + y <- codeIn the next step the lines are grouped into "chunks" of markdown and code. This is done by simply collecting adjacent lines of the same "type" into chunks:
# # Rational numbers ┐
-# │
-# In julia rational numbers can be constructed with the `//` operator. │ markdown
-# Lets define two rational numbers, `x` and `y`: ┘
- ┐
-x = 1 // 3 │
-y = 2 // 5 │ code
- ┘
-# When adding `x` and `y` together we obtain a new rational number: ] markdown
- ┐
-z = x + y ┘ codeIn the last parsing step all empty leading and trailing lines for each chunk are removed, but empty lines within the same block are kept. The leading # tokens are also removed from the markdown chunks. Finally we would end up with the following 4 chunks:
Chunks #1:
# Rational numbers
-
-In julia rational numbers can be constructed with the `//` operator.
-Lets define two rational numbers, `x` and `y`:Chunk #2:
x = 1 // 3
-y = 2 // 5Chunk #3:
When adding `x` and `y` together we obtain a new rational number:Chunk #4:
z = x + yIt is then up to the Document generation step to decide how these chunks should be treated.
Sometimes it is convenient to be able to manually control how the chunks are split. For example, if you want to split a block of code into two, such that they end up in two different @example blocks or notebook cells. The #- token can be used for this purpose. All lines starting with #- are used as "chunk-splitters":
x = 1 // 3
-y = 2 // 5
-#-
-z = x + yThe example above would result in two consecutive code-chunks.
Tip
The rest of the line, after #-, is discarded, so it is possible to use e.g. #------------- as a chunk splitter, which may make the source code more readable.
After the parsing it is time to generate the output. What is done in this step is very different depending on the output target, and it is describe in more detail in the Output format sections: Markdown Output , Notebook Output and Script Output . Using the default settings, the following is happening:
Markdown output: markdown chunks are printed as-is, code chunks are put inside a code fence (defaults to @example-blocks), Notebook output: markdown chunks are printed in markdown cells, code chunks are put in code cells, Script output: markdown chunks are discarded, code chunks are printed as-is. When the document is generated the user, again, has the option to hook-into the generation with a custom post-processing function. The reason is that one might want to change things that are only visible in the rendered document. See Custom pre- and post-processing .
The last step of the generation is writing to file. The result is written to $(outputdir)/$(name)(.md|.ipynb|.jl) where outputdir is the output directory supplied by the user (for example docs/generated), and name is a user supplied filename. It is recommended to add the output directory to .gitignore since the idea is that the generated documents will be generated as part of the build process rather than beeing files in the repo.
3. Processing pipeline · Literate.jl Literate.jl The generation of output follows the same pipeline for all output formats:
Pre-processing Parsing Document generation Post-processing Writing to file The first step is pre-processing of the input file. The file is read to a String. The first processing step is to apply the user specified pre-processing function, see Custom pre- and post-processing .
The next step is to perform all of the built-in default replacements. CRLF style line endings ("\r\n") are replaced with LF line endings ("\n") to simplify internal processing. Next, line filtering is performed, see Filtering Lines , meaning that lines starting with #md, #nb or #jl are handled (either just the token itself is removed, or the full line, depending on the output target). The last pre-processing step is to expand the convenience "macros" described in Default Replacements is expanded.
After the preprocessing the file is parsed. The first step is to categorize each line and mark them as either markdown or code according to the rules described in the Syntax section. Lets consider the example from the previous section with each line categorized:
# # Rational numbers <- markdown
+# <- markdown
+# In julia rational numbers can be constructed with the `//` operator. <- markdown
+# Lets define two rational numbers, `x` and `y`: <- markdown
+ <- code
+x = 1 // 3 <- code
+y = 2 // 5 <- code
+ <- code
+# When adding `x` and `y` together we obtain a new rational number: <- markdown
+ <- code
+z = x + y <- codeIn the next step the lines are grouped into "chunks" of markdown and code. This is done by simply collecting adjacent lines of the same "type" into chunks:
# # Rational numbers ┐
+# │
+# In julia rational numbers can be constructed with the `//` operator. │ markdown
+# Lets define two rational numbers, `x` and `y`: ┘
+ ┐
+x = 1 // 3 │
+y = 2 // 5 │ code
+ ┘
+# When adding `x` and `y` together we obtain a new rational number: ] markdown
+ ┐
+z = x + y ┘ codeIn the last parsing step all empty leading and trailing lines for each chunk are removed, but empty lines within the same block are kept. The leading # tokens are also removed from the markdown chunks. Finally we would end up with the following 4 chunks:
Chunks #1:
# Rational numbers
+
+In julia rational numbers can be constructed with the `//` operator.
+Lets define two rational numbers, `x` and `y`:Chunk #2:
x = 1 // 3
+y = 2 // 5Chunk #3:
When adding `x` and `y` together we obtain a new rational number:Chunk #4:
z = x + yIt is then up to the Document generation step to decide how these chunks should be treated.
Sometimes it is convenient to be able to manually control how the chunks are split. For example, if you want to split a block of code into two, such that they end up in two different @example blocks or notebook cells. The #- token can be used for this purpose. All lines starting with #- are used as "chunk-splitters":
x = 1 // 3
+y = 2 // 5
+#-
+z = x + yThe example above would result in two consecutive code-chunks.
Tip
The rest of the line, after #-, is discarded, so it is possible to use e.g. #------------- as a chunk splitter, which may make the source code more readable.
After the parsing it is time to generate the output. What is done in this step is very different depending on the output target, and it is describe in more detail in the Output format sections: Markdown Output , Notebook Output and Script Output . Using the default settings, the following is happening:
Markdown output: markdown chunks are printed as-is, code chunks are put inside a code fence (defaults to @example-blocks), Notebook output: markdown chunks are printed in markdown cells, code chunks are put in code cells, Script output: markdown chunks are discarded, code chunks are printed as-is. When the document is generated the user, again, has the option to hook-into the generation with a custom post-processing function. The reason is that one might want to change things that are only visible in the rendered document. See Custom pre- and post-processing .
The last step of the generation is writing to file. The result is written to $(outputdir)/$(name)(.md|.ipynb|.jl) where outputdir is the output directory supplied by the user (for example docs/generated), and name is a user supplied filename. It is recommended to add the output directory to .gitignore since the idea is that the generated documents will be generated as part of the build process rather than beeing files in the repo.
Search · Literate.jl Literate.jl Search Number of results: loading...
Search · Literate.jl Literate.jl Search Number of results: loading...