Skip to content

Commit 7dcdeda

Browse files
mb-emagtwodrops
authored andcommitted
docs: added a table of static doxygen page names
Signed-off-by: Markus Braun <[email protected]>
1 parent 6fa20d6 commit 7dcdeda

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: docs/linking_to_doxygen.md

+15
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,21 @@ This is typically used to reference the root docs or some special page where you
164164
``````
165165
```````
166166

167+
````{tip}
168+
As for each doxygen html file an equally named rst file will be created by doxysphinx you can just reference
169+
the doxygen sections via their names. However as these aren't always obvious here's a list:
170+
171+
| Doxygen page title | html/rst name | example link (e.g. for toctree or doc link) | rendered example |
172+
| --- | --- | --- | --- |
173+
| Main Page | index | `/docs/doxygen/demo/html/index` | {doc}`/docs/doxygen/demo/html/index` |
174+
| Namespace List | namespaces | `/docs/doxygen/demo/html/namespaces` | {doc}`/docs/doxygen/demo/html/namespaces` |
175+
| Class List | annotated | `/docs/doxygen/demo/html/annotated` | {doc}`/docs/doxygen/demo/html/annotated` |
176+
| Class Index | classes | `/docs/doxygen/demo/html/classes` | {doc}`/docs/doxygen/demo/html/classes` |
177+
| Class Hierachy | inherits | `/docs/doxygen/demo/html/inherits` | {doc}`/docs/doxygen/demo/html/inherits` |
178+
| Class Members | functions | `/docs/doxygen/demo/html/functions` | {doc}`/docs/doxygen/demo/html/functions` |
179+
| Files | files | `/docs/doxygen/demo/html/files` | {doc}`/docs/doxygen/demo/html/files` |
180+
````
181+
167182
## via doxylink symbol links
168183

169184
When you set up doxylink correctly (see [](getting_started.md#step-2-install-and-setup-doxylink)) you can

0 commit comments

Comments
 (0)