Skip to content

Commit afb3929

Browse files
authored
canonize docs (#122)
1 parent 877a3b2 commit afb3929

File tree

4 files changed

+21
-22
lines changed

4 files changed

+21
-22
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# ModelingToolkitStandardLibrary.jl
22

33
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](http://mtkstdlib.sciml.ai/stable/)
5-
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/dev/modules/ModelingToolkitStandardLibrary/)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/)
65

76
[![codecov](https://codecov.io/gh/SciML/ModelingToolkitStandardLibrary.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/SciML/ModelingToolkitStandardLibrary.jl)
87
[![Build Status](https://github.com/SciML/ModelingToolkitStandardLibrary.jl/workflows/CI/badge.svg)](https://github.com/SciML/ModelingToolkitStandardLibrary.jl/actions?query=workflow%3ACI)
@@ -26,23 +25,23 @@ import Pkg; Pkg.add("ModelingToolkitStandardLibrary")
2625
## Tutorials and Documentation
2726

2827
For information on using the package,
29-
[see the stable documentation](https://mtkstdlib.sciml.ai/stable/). Use the
30-
[in-development documentation](https://mtkstdlib.sciml.ai/dev/) for the version of
28+
[see the stable documentation](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/). Use the
29+
[in-development documentation](https://docs.sciml.ai/ModelingToolkitStandardLibrary/dev/) for the version of
3130
the documentation, which contains the unreleased features.
3231

3332
## Libraries
3433

3534
The following are the constituant libraries of the ModelingToolkit Standard Library.
3635

37-
- [Basic Blocks](http://mtkstdlib.sciml.ai/dev/API/blocks/)
38-
- [Mechanical Components](http://mtkstdlib.sciml.ai/dev/API/mechanical/)
39-
- [Electrical Components](http://mtkstdlib.sciml.ai/dev/API/electrical/)
40-
- [Magnetic Components](http://mtkstdlib.sciml.ai/dev/API/magnetic/)
41-
- [Thermal Components](http://mtkstdlib.sciml.ai/dev/API/thermal/)
36+
- [Basic Blocks](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/blocks/)
37+
- [Mechanical Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/mechanical/)
38+
- [Electrical Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/electrical/)
39+
- [Magnetic Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/magnetic/)
40+
- [Thermal Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/thermal/)
4241

4342
## Example
4443

45-
The following is the [RC Circuit Demonstration](http://mtkstdlib.sciml.ai/dev/tutorials/rc_circuit/):
44+
The following is the [RC Circuit Demonstration](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/tutorials/rc_circuit/):
4645

4746
```julia
4847
using ModelingToolkit, OrdinaryDiffEq, Plots

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ makedocs(sitename = "ModelingToolkitStandardLibrary.jl",
2828
ModelingToolkitStandardLibrary.Electrical,
2929
ModelingToolkitStandardLibrary.Thermal],
3030
format = Documenter.HTML(assets = ["assets/favicon.ico"],
31-
canonical = "https://mtkstdlib.sciml.ai/stable/"),
31+
canonical = "https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/"),
3232
pages = pages)
3333

3434
deploydocs(repo = "github.com/SciML/ModelingToolkitStandardLibrary.jl";

docs/src/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ModelingToolkitStandardLibrary.jl
22

33
ModelingToolkitStandardLibrary.jl is a standard library for the
4-
[ModelingToolkit](https://mtk.sciml.ai/dev/) acasual modeling system.
4+
[ModelingToolkit](https://docs.sciml.ai/ModelingToolkit/stable/) acasual modeling system.
55

66
## Installation
77

@@ -14,18 +14,18 @@ import Pkg; Pkg.add("ModelingToolkitStandardLibrary")
1414

1515
## Tutorials
1616

17-
- [RC Circuit](http://mtkstdlib.sciml.ai/dev/tutorials/rc_circuit/)
18-
- [Custom Component](http://mtkstdlib.sciml.ai/dev/tutorials/custom_component/)
19-
- [Thermal Model](http://mtkstdlib.sciml.ai/dev/tutorials/thermal_model/)
20-
- [DC Motor with PI-controller](http://mtkstdlib.sciml.ai/dev/tutorials/dc_motor_pi/)
17+
- [RC Circuit](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/tutorials/rc_circuit/)
18+
- [Custom Component](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/tutorials/custom_component/)
19+
- [Thermal Model](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/tutorials/thermal_model/)
20+
- [DC Motor with PI-controller](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/tutorials/dc_motor_pi/)
2121

2222
## Libraries
2323

2424
The following are the constituant libraries of the ModelingToolkit Standard Library.
2525

26-
- [Basic Blocks](http://mtkstdlib.sciml.ai/dev/API/blocks/)
27-
- [Mechanical Components](http://mtkstdlib.sciml.ai/dev/API/mechanical/)
28-
- [Electrical Components](http://mtkstdlib.sciml.ai/dev/API/electrical/)
29-
- [Magnetic Components](http://mtkstdlib.sciml.ai/dev/API/magnetic/)
30-
- [Thermal Components](http://mtkstdlib.sciml.ai/dev/API/thermal/)
26+
- [Basic Blocks](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/blocks/)
27+
- [Mechanical Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/mechanical/)
28+
- [Electrical Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/electrical/)
29+
- [Magnetic Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/magnetic/)
30+
- [Thermal Components](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/thermal/)
3131

docs/src/tutorials/rc_circuit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# RC Circuit Model
22

33
This tutorial is a simplified version of the [RC circuit tutorial in the
4-
`ModelingToolkit.jl` documentation](https://mtk.sciml.ai/dev/tutorials/acausal_components/).
4+
`ModelingToolkit.jl` documentation](https://docs.sciml.ai/ModelingToolkit/stable/tutorials/acausal_components/).
55
In that tutorial, the full RC circuit is built from scratch. Here, we will use the
66
components of the `Electrical` model in the ModelingToolkit Standard Library to simply
77
connect pre-made components and simulate the model.

0 commit comments

Comments
 (0)