Skip to content

Commit 95d388e

Browse files
committed
Fixed some docs
1 parent adaf775 commit 95d388e

File tree

5 files changed

+24
-12
lines changed

5 files changed

+24
-12
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
docs/build/
2+
docs/site/

docs/builddocs

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
1-
julia make.jl
1+
#!/bin/sh
2+
if [ $# -eq 0 ]
3+
then
4+
juliapath=julia
5+
else
6+
juliapath=$1
7+
fi
8+
9+
$juliapath -e '"Lapidary" in keys(Pkg.installed()) || Pkg.clone("https://github.com/MichaelHatherly/Lapidary.jl");'
10+
$juliapath -e '"PyPlot" in keys(Pkg.installed()) || Pkg.add("PyPlot");'
11+
12+
$juliapath make.jl
13+
214
mkdocs build --clean

docs/src/lib/plotting.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Plotting
2-
31
{index}
42
Pages = ["plotting.md"]
53

docs/src/man/creatingtfs.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Creating Transfer Functions
1+
{meta}
2+
DocTestSetup = quote
3+
using ControlSystems
4+
end
25

36
## tf - Rational Representation
47
The syntax for creating a transfer function is
@@ -23,7 +26,7 @@ Continuous-time transfer function model
2326
The transfer functions created using this method will be of type `TransferFunction{SisoRational}`.
2427

2528
## zpk - Pole-Zero-Gain Representation
26-
Sometime it's better to represent the transferfunction by its poles, zeros and gain, this can be done using
29+
Sometimes it's better to represent the transferfunction by its poles, zeros and gain, this can be done using
2730
```julia
2831
zpk(zeros, poles, gain, Ts=0)
2932
```
@@ -45,7 +48,7 @@ Continuous-time transfer function model
4548
The transfer functions created using this method will be of type `TransferFunction{SisoZpk}`.
4649

4750
## tfa - Generalized Representation
48-
If you want to work with transfer functions that are not rational function, it is possible to use the `tfa` representation
51+
If you want to work with transfer functions that are not rational functions, it is possible to use the `tfa` representation
4952
```julia
5053
tfa(str::String), tfa(str::Expr)
5154
```
@@ -54,20 +57,20 @@ This function will either convert `str` to an expression or directly accept an `
5457
```julia
5558
tfa("1/((s+1)*exp(-sqrt(s)))")
5659

57-
# output
60+
## output
5861

5962
TransferFunction:
6063
1/((s+1)*exp(-sqrt(s)))
6164

6265
Continuous-time transfer function model
6366
```
6467
The transfer functions created using this method will be of type `TransferFunction{SisoGeneralized}`.
65-
This type will work with some functions like `bodeplot, stepplot` but not others (like `poles`).
68+
This type will work with some functions like `bodeplot, stepplot` but not others ,like `poles`.
6669

6770
## Converting between types
6871
It is sometime useful to convert one representation to another, this is possible using the same functions, for example
6972
```julia
70-
tf(zpk([-1],[1],2))
73+
tf(zpk([-1], [1], 2, 0.1))
7174

7275
# output
7376

docs/src/man/introduction.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
# Introduction
2-
31
## Installation
42

53
To install this package simply run
6-
## Installation
74
```julia
85
Pkg.add("ControlSystems")
96
```

0 commit comments

Comments
 (0)