diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..8fca1b797 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +_build/ +_doxygen/ \ No newline at end of file diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 000000000..4ace9151d --- /dev/null +++ b/docs/license.md @@ -0,0 +1,4 @@ +# License + +```{include} ../LICENSE +``` \ No newline at end of file diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 1d983642f..84b6b5c6e 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -57,3 +57,7 @@ subtrees: - file: reference/development-guide.rst title: Development guide + + - caption: About + entries: + - file: license.md diff --git a/docs/what-is-omnitrace.rst b/docs/what-is-omnitrace.rst index 8de3af550..0282c7ebe 100644 --- a/docs/what-is-omnitrace.rst +++ b/docs/what-is-omnitrace.rst @@ -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