diff --git a/latest/documenter.html b/latest/documenter.html index 40a9243..9920140 100644 --- a/latest/documenter.html +++ b/latest/documenter.html @@ -5,4 +5,8 @@ # code ```
  • The following @meta block will be added to the top of the markdown page, which redirects the "Edit on GitHub" link on the top of the page to the source file rather than the generated .md file:
    ```@meta
 EditURL = "$(relpath(inputfile, outputdir))"
-```

    • Examples.notebook:

    +```

    Examples.notebook:

    diff --git a/latest/outputformats.html b/latest/outputformats.html index 76f7a22..f413811 100644 --- a/latest/outputformats.html +++ b/latest/outputformats.html @@ -17,4 +17,4 @@ Here is an example with some code ```@example x = sin.(cos.([1, 2, 3])) y = x.^2 - x -```
    Examples.markdown — Function.
    Examples.markdown(inputfile, outputdir; kwargs...)

    Generate a markdown file from inputfile and write the result to the directoryoutputdir.

    Keyword arguments:

    • name: name of the output file, excluding .md. name is also used to name all the @example blocks. 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 tells if the output is intended to use with Documenter.jl. Defaults to true. See the the manual section on Interaction with Documenter.
    • codefence: A Pair of opening and closing code fence. Defaults to
      "```@example $(name)" => "```"
      if documenter = true and
      "```julia" => "```"
      if documenter = false.
    source

    4.2. Notebook output

    Examples.notebook — Function.
    Examples.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. 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.
    • 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.
    source

    4.3. Script output

    Examples.script — Function.
    Examples.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. 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.
    source
    +```
    Examples.markdown — Function.
    Examples.markdown(inputfile, outputdir; kwargs...)

    Generate a markdown file from inputfile and write the result to the directoryoutputdir.

    Keyword arguments:

    • name: name of the output file, excluding .md. name is also used to name all the @example blocks. 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 tells if the output is intended to use with Documenter.jl. Defaults to true. See the the manual section on Interaction with Documenter.
    • codefence: A Pair of opening and closing code fence. Defaults to
      "```@example $(name)" => "```"
      if documenter = true and
      "```julia" => "```"
      if documenter = false.
    source

    4.2. Notebook output

    Examples.notebook — Function.
    Examples.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. 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.
    • 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.
    source

    4.3. Script output

    Examples.script — Function.
    Examples.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. 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.
    source
    diff --git a/latest/search_index.js b/latest/search_index.js index e3b04fe..e44fe2f 100644 --- a/latest/search_index.js +++ b/latest/search_index.js @@ -229,7 +229,7 @@ var documenterSearchIndex = {"docs": [ "page": "6. Interaction with Documenter.jl", "title": "6. Interaction with Documenter.jl", "category": "section", - "text": "Examples.jl 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 (Examples.markdown, Examples.notebook and Examples.script) supports a keyword argument documenter that lets the generator perform some extra things, keeping in mind that the generated files will, eventually, be used with Documenter.jl. So lets take a look at what will happen if we set documenter = true:Examples.markdown:The default code fence will change from\n```julia\n# code\n```\nto Documenters @example blocks:\n```@examples $(name)\n# code\n```\nThe following @meta block will be added to the top of the markdown page, which redirects the \"Edit on GitHub\" link on the top of the page to the source file rather than the generated .md file:\n```@meta\nEditURL = \"$(relpath(inputfile, outputdir))\"\n```Examples.notebook: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 notebook." + "text": "Examples.jl 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 (Examples.markdown, Examples.notebook and Examples.script) supports a keyword argument documenter that lets the generator perform some extra things, keeping in mind that the generated files will, eventually, be used with Documenter.jl. So lets take a look at what will happen if we set documenter = true:Examples.markdown:The default code fence will change from\n```julia\n# code\n```\nto Documenters @example blocks:\n```@examples $(name)\n# code\n```\nThe following @meta block will be added to the top of the markdown page, which redirects the \"Edit on GitHub\" link on the top of the page to the source file rather than the generated .md file:\n```@meta\nEditURL = \"$(relpath(inputfile, outputdir))\"\n```Examples.notebook: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 notebook.\nDocumenter style markdown math\n```math\n\\int f dx\n```\nis replaced with notebook compatible\n\\begin{equation}\n\\int f dx\n\\end{equation}" }, {