Skip to content

Commit faa8cb0

Browse files
committed
Link to QuantumPropagators how-tos
1 parent f7ca9e4 commit faa8cb0

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ makedocs(;
114114
"Glossary" => "glossary.md",
115115
"Overview" => "overview.md",
116116
"Control Methods" => "methods.md",
117-
"Howto" => "howto.md",
117+
"How-to Guides" => "howto.md",
118118
"Examples" => "examples/index.md",
119119
"API" => [
120120
"QuantumControl" => "api/quantum_control.md",

docs/src/howto.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
1-
# Howto
1+
# [How-to Guides](@id howto)
2+
3+
**Contents**
4+
5+
```@contents
6+
Pages=[
7+
"howto.md"
8+
]
9+
Depth = 2:2
10+
```
11+
12+
Also see the following how-to guides from the [QuantumPropagators documentation](@extref QuantumPropagators :doc:howto):
13+
14+
```@eval
15+
using Markdown
16+
using DocInventories
17+
18+
inventory = Inventory("https://juliaquantumcontrol.github.io/QuantumPropagators.jl/stable/objects.inv")
19+
20+
howtos = [item for item in inventory if item.role == "label" && startswith(item.uri, "howto") && item.name != "Howtos"]
21+
22+
lines = ["* [$(DocInventories.dispname(item))]($(DocInventories.uri(inventory, DocInventories.spec(item))))" for item in howtos]
23+
24+
Markdown.parse(join(lines, "\n"))
25+
```
26+
227

328
## How to deal with long-running calculations
429

0 commit comments

Comments
 (0)