Skip to content

Commit

Permalink
Fix a few loose ends and add link to license page
Browse files Browse the repository at this point in the history
  • Loading branch information
amd-jnovotny committed Jun 28, 2024
1 parent 39c4fb1 commit 7ae8753
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_build/
_doxygen/
4 changes: 4 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License

```{include} ../LICENSE
```

Check failure on line 4 in docs/license.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Files should end with a single newline character

docs/license.md:4:3 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md047.md
4 changes: 4 additions & 0 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,7 @@ subtrees:

- file: reference/development-guide.rst
title: Development guide

- caption: About
entries:
- file: license.md
4 changes: 2 additions & 2 deletions docs/what-is-omnitrace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ and visualization in Jupyter notebooks.

To use Omnitrace for instrumentation, follow these two configuration steps:

#. Indicate the functions and modules to instrument in the target binaries, including the executable and any libraries
#. Specify the type of instrumentation to perform when the instrumented binaries are executed
#. Indicate the functions and modules to :doc:`instrument <./how-to/instrumenting-rewriting-binary-application>` in the target binaries, including the executable and any libraries
#. Specify the :doc:`type of instrumentation <./how-to/configuring-runtime-options>` to perform when the instrumented binaries are executed

0 comments on commit 7ae8753

Please sign in to comment.