Skip to content

Commit eefe5f2

Browse files
committed
Fix documentation issues
Signed-off-by: Cristian Le <[email protected]>
1 parent bedc0cc commit eefe5f2

File tree

7 files changed

+17
-20
lines changed

7 files changed

+17
-20
lines changed

cmake/DynamicVersion.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# [`DynamicVersion.cmake`](DynamicVersion.cmake)
22

3+
<!-- SPHINX-START -->
4+
35
Calculate the project version from the git tags or `.git_archival.txt` if the source is not a git repository
46

57
## Example
@@ -27,3 +29,5 @@ add_dependencies(version_lib My_Project_Version)
2729
set_property(SOURCE version.cpp.in APPEND PROPERTY
2830
OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/.version)
2931
```
32+
33+
<!-- SPHINX-END -->

cmake/PackageComps.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# [`PackageComps.cmake`](PackageComps.cmake)
22

3+
<!-- SPHINX-START -->
4+
35
Export and import targets as individual components. Special components `shared` and `static`
46

57
## Example
@@ -54,3 +56,5 @@ project(Downstream_Project)
5456
5557
find_package(My_Project COMPONENTS my_component)
5658
```
59+
60+
<!-- SPHINX-END -->
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# DynamicVersion
22

33
```{include} ../../cmake/DynamicVersion.md
4-
: start-after: "# [`DynamicVersion.cmake`](DynamicVersion.cmake)"
4+
:start-after: <!-- SPHINX-START -->
5+
:end-before: <!-- SPHINX-END -->
56
```

docs/cmake_modules/PackageComps.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# PackageComps
22

33
```{include} ../../cmake/PackageComps.md
4-
: start-after: "# [`PackageComps.cmake`](PackageComps.cmake)"
4+
:start-after: <!-- SPHINX-START -->
5+
:end-before: <!-- SPHINX-END -->
56
```

docs/cmake_modules/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# CMake modules
22

33
```{toctree}
4-
: maxdepth: 1
5-
: titlesonly: true
6-
: caption: Contents
7-
: glob: true
4+
:titlesonly: true
85
9-
./*
6+
DynamicVersion
7+
PackageComps
108
```

docs/index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,9 @@
22

33
CMakeExtraUtils is a collection of cmake modules designed to help you manage and export your cmake project.
44

5-
See the [installation guide](install) for details on how to import this project and
6-
[CMake modules](cmake_modules/index) for the modules available.
7-
85
```{toctree}
9-
: maxdepth: 2
10-
: titlesonly: true
11-
: caption: Contents
6+
:hidden: true
127
13-
install
8+
self
149
cmake_modules/index
1510
```

docs/install.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)