language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-01 22:31:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

C++ docs: Provide a short intro paragraph to the reference section

Browse source
This commit is contained in:
Simon Hausmann 2021-07-02 10:15:48 +02:00
parent 69bbef529c
commit 45f62f5f11
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
api/sixtyfps-cpp/docs/conf.py
View file

@ -13,6 +13,7 @@
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
import textwrap
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@ -41,6 +42,18 @@ exhale_args = {
"containmentFolder": "./api", "containmentFolder": "./api",
"rootFileName": "library_root.rst", "rootFileName": "library_root.rst",
"rootFileTitle": "C++ API Reference", "rootFileTitle": "C++ API Reference",
"afterTitleDescription": textwrap.dedent('''
.. note::
The following sections present the C++ API Reference. All types are
within the :ref:`sixtyfps<namespace_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<namespace_sixtyfps__interpreter>`, starting at
:cpp:class:`sixtyfps::interpreter::ComponentCompiler`. You need to include
the :code:`sixtyfps_interpreter.h` header file.
'''),
"doxygenStripFromPath": "..", "doxygenStripFromPath": "..",
"createTreeView": True, "createTreeView": True,
"exhaleExecutesDoxygen": True, "exhaleExecutesDoxygen": True,