Skip to content

Commit 5fe23b8

Browse files
authored
Add system for building hidden future tutorials (#24)
1 parent ca24eee commit 5fe23b8

8 files changed

Lines changed: 77 additions & 7 deletions

File tree

A_study_of_studies/index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ objective of this tutorial is to explain the sequence of a typical study from
1212
its mechanical system information, to the initial conditions, kinematics to the
1313
inverse dynamic analysis.
1414

15-
::::{if-builder:: html
16-
```{rubric} Tutorial content
17-
```
18-
::::
19-
2015
```{toctree}
2116
:maxdepth: 1
2217

Introduction_to_mechanics/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
::: {rst-class} break
3+
:::
4+
5+
6+
# Introduction to mechanics in AnyBody
7+
8+
9+
The individual windows will be explained in greater detail in the
10+
following lessons:
11+
12+
```{toctree}
13+
:maxdepth: 1
14+
15+
Lesson1 <lesson1>
16+
17+
```
18+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
::: {rst-class} break
2+
:::
3+
4+
# Lesson 1: What is multibody dynamics
5+
6+
hello world
7+
8+
## Subsection 1
9+
10+
hello again

Tutorials.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,8 @@ Posture_and_movement/intro
6666
Interface_features/index
6767
Troubleshooting_anyscript/intro
6868
Validation_of_models/index
69-
```
69+
```
70+
71+
72+
73+

Tutorials_future.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sd_hide_title: true
3+
---
4+
:::::::::{if-builder} html
5+
6+
# **Future Tutorials**
7+
8+
9+
```{rubric} Future tutorials
10+
:class: sd-fs-4
11+
```
12+
13+
You can find the available tutorials in the sidebar. The tutorials are ordered in a suitable sequence for new users who are unfamiliar with AnyBody, but this sequence may not be optimal for you depending on your background and interests.
14+
15+
16+
{doc}`Introduction to mechanics </Introduction_to_mechanics/index>`
17+
: Shows the basics of AnyBody.
18+
19+
20+
:::::::::
21+
22+
23+
24+
```{toctree}
25+
:caption: Future tutorials
26+
:includehidden: true
27+
:maxdepth: 2
28+
:hidden: true
29+
:titlesonly: true
30+
31+
Introduction_to_mechanics/index
32+
33+
```
34+
35+
36+
37+

conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ def tagged_commit():
123123
".pytest_cache",
124124
]
125125

126+
if not tags.has("future_tutorials"):
127+
exclude_patterns.append("Tutorials_future.md")
128+
exclude_patterns.append("Introduction_to_mechanics/*")
129+
126130

127131
# The name of the Pygments (syntax highlighting) style to use.
128132
highlight_language = "AnyScriptDoc"

index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,10 @@ GettingStarted
143143
:maxdepth: 2
144144
:hidden:
145145
:titlesonly: True
146+
:glob:
146147
147148
148-
Tutorials
149+
Tutorials*
149150
about
150151
```
151152

pixi.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ clean = "rm -rf _build"
1111
linkcheck = {cmd="sphinx-build -M linkcheck . _build -q", depends-on = ["clean"]}
1212
build-pdf = {cmd="sphinx-build -M simplepdf . _build", depends-on = ["clean"]}
1313
build-html = "sphinx-build -M html . _build"
14+
build-html-future = "sphinx-build -M html . _build -t future_tutorials"
1415
build-html-all = "sphinx-build -M html . _build -a"
1516
html = {cmd= 'explorer .\_build\html\index.html', depends_on = ["build-html-all"]}
1617
pdf = {cmd= 'explorer .\_build\simplepdf\Agada-Documentation.pdf', depends_on = ["build-pdf"]}

0 commit comments

Comments
 (0)