diff --git a/api/sixtyfps-cpp/docs/conf.py b/api/sixtyfps-cpp/docs/conf.py index 21b6466bd..464f9418a 100644 --- a/api/sixtyfps-cpp/docs/conf.py +++ b/api/sixtyfps-cpp/docs/conf.py @@ -13,6 +13,7 @@ # import os # import sys # sys.path.insert(0, os.path.abspath('.')) +import textwrap # -- Project information ----------------------------------------------------- @@ -41,6 +42,18 @@ exhale_args = { "containmentFolder": "./api", "rootFileName": "library_root.rst", "rootFileTitle": "C++ API Reference", + "afterTitleDescription": textwrap.dedent(''' + .. note:: + + The following sections present the C++ API Reference. All types are + within the :ref:`sixtyfps` namespace and are accessible by including + the :code:`sixtyfps.h` header file. + + If you choose to load :code:`.60` files dynamically at run-time, then + you can use the classes in :ref:`sixtyfps::interpreter`, starting at + :cpp:class:`sixtyfps::interpreter::ComponentCompiler`. You need to include + the :code:`sixtyfps_interpreter.h` header file. + '''), "doxygenStripFromPath": "..", "createTreeView": True, "exhaleExecutesDoxygen": True,