Skip to content
Snippets Groups Projects
Commit abde9574 authored by Fredrik Bagge Carlson's avatar Fredrik Bagge Carlson
Browse files

Add docs skeleton

parent 88b46f77
No related branches found
No related tags found
No related merge requests found
*.jl.cov *.jl.cov
*.jl.*.cov *.jl.*.cov
*.jl.mem *.jl.mem
docs/build/
docs/site/
docs/.documenter
...@@ -48,7 +48,7 @@ These functions can be used to implement your own control loops. A common loop ...@@ -48,7 +48,7 @@ These functions can be used to implement your own control loops. A common loop
with a feedback controller and a feedforward filter on the reference is implemented with a feedback controller and a feedforward filter on the reference is implemented
in the function [`run_control_2DOF`](@ref), where the user can supply $G_1$ and $G_4$ in the function [`run_control_2DOF`](@ref), where the user can supply $G_1$ and $G_4$
in the diagram below, with the process $P=G_2$. in the diagram below, with the process $P=G_2$.
![block diagram](docs/feedback4.png) ![block diagram](docs/src/feedback4.png)
The macro `@periodically` might come in handy if you want to implement your own loop. The macro `@periodically` might come in handy if you want to implement your own loop.
Consider the following example, in which the loop body will be run periodically Consider the following example, in which the loop body will be run periodically
......
using Documenter, LabProcesses
# makedocs()
# deploydocs(
# deps = Deps.pip("pygments", "mkdocs", "python-markdown-math", "mkdocs-cinder"),
# repo = "gitlab.control.lth.se/processes/LabProcesses.jl",
# branch = "gh-pages",
# julia = "0.6",
# osname = "linux"
# )
makedocs(
format = :html,
sitename = "LabProcesses",
pages = [
"index.md",
]
)
deploydocs(
repo = "gitlab.control.lth.se/processes/LabProcesses.jl.git",
branch = "gh-pages",
target = "build",
deps = nothing,
make = nothing
)
site_name: LabProcesses.jl
repo_url: https://gitlab.control.lth.se/labdev/software/tree/master/julia_ballandbeam/LabProcesses.jl
site_description: Documentation for LabProcesses.jl
site_author: Fredri Bagge Carlson
theme: cinder
extra_css:
- assets/Documenter.css
extra_javascript:
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
- assets/mathjaxhelper.js
markdown_extensions:
- extra
- tables
- fenced_code
- mdx_math:
enable_dollar_delimiter: True
docs_dir: 'build'
pages:
- Home: index.md
File moved
# LabProcesses
```@contents
Depth = 3
```
# Installation
Install `LabProcesses.jl` using command `Pkg.clone("https://gitlab.control.lth.se/processes/LabProcesses.jl.git")` Lots of packages will now be installed, this might take some time.
# Exported functions and types
```@autodocs
Modules = [LabProcesses]
Private = false
Pages = ["LabProcesses.jl"]
```
# Index
```@index
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment