Skip to content

Commit 713deef

Browse files
Q-MinhQ-Minh
committed
Define hierarchical page navigation
1 parent ecb0501 commit 713deef

File tree

10 files changed

+82
-17
lines changed

10 files changed

+82
-17
lines changed

‎doc/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ if (DOXYGEN_FOUND)
8282
"build.md"
8383
"install.md"
8484
"profiling.md"
85+
"userguide.md"
8586
ALL
8687
COMMENT "Generating docs"
8788
)

‎doc/build.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
Building
2-
===
1+
\page build Build
32

3+
4+
- \subpage dependencies
5+
- \subpage configuration
6+
- \subpage install
7+
8+
<div class="section_buttons">
9+
10+
| Previous | Next |
11+
|:----------------|------------------:|
12+
| \ref quickstart | \ref dependencies |
13+
14+
</div>

‎doc/configuration.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
Configuration
2-
===
1+
\page configuration Configuration
32

3+
<div class="section_buttons">
4+
5+
| Previous | Next |
6+
|:------------------|-------------:|
7+
| \ref dependencies | \ref install |
8+
9+
</div>

‎doc/dependencies.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
Dependencies
2-
===
1+
\page dependencies Dependencies
2+
3+
<div class="section_buttons">
4+
5+
| Previous | Next |
6+
|:-----------|-------------------:|
7+
| \ref build | \ref configuration |
8+
9+
</div>

‎doc/features.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
Features
2-
===
1+
\page features Features
2+
3+
<div class="section_buttons">
4+
5+
| Previous | Next |
6+
|:---------------|----------------:|
7+
| \ref index | \ref quickstart |
8+
9+
</div>

‎doc/install.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
Installation
2-
===
1+
\page install Install
32

3+
<div class="section_buttons">
4+
5+
| Previous | Next |
6+
|:-------------------|---------------:|
7+
| \ref configuration | \ref userguide |
8+
9+
</div>

‎doc/main.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Overview {#mainpage}
2-
===
1+
\mainpage Overview
32

43
[![build](https://github.com/Q-Minh/PhysicsBasedAnimationToolkit/actions/workflows/pyinstall.yml/badge.svg)](https://github.com/Q-Minh/PhysicsBasedAnimationToolkit/actions/workflows/pyinstall.yml)
54
[![wheels](https://github.com/Q-Minh/PhysicsBasedAnimationToolkit/actions/workflows/wheels.yml/badge.svg?event=release)](https://github.com/Q-Minh/PhysicsBasedAnimationToolkit/actions/workflows/wheels.yml)
@@ -20,10 +19,13 @@ Overview {#mainpage}
2019
```
2120
</div>
2221

22+
- \subpage features
23+
- \subpage quickstart
24+
2325
<div class="section_buttons">
2426

2527
| Next |
2628
|------------------------:|
27-
| [features](features.md) |
29+
| \ref features |
2830

2931
</div>

‎doc/profiling.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
Profiling
2-
===
1+
\page profiling Profiling
2+
3+
<div class="section_buttons">
4+
5+
| Previous |
6+
|:---------------|
7+
| \ref userguide |
8+
9+
</div>

‎doc/quickstart.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
1-
Quick start
2-
===
1+
\page quickstart Quick start
2+
3+
<div class="section_buttons">
4+
5+
| Previous | Next |
6+
|:--------------|-----------:|
7+
| \ref features | \ref build |
8+
9+
</div>

‎doc/userguide.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
\page userguide User guide
2+
3+
- \subpage profiling
4+
5+
<div class="section_buttons">
6+
7+
| Previous | Next |
8+
|:-------------|---------------:|
9+
| \ref install | \ref profiling |
10+
11+
</div>

0 commit comments

Comments
 (0)