Mirrors_UI_SDK/lvgl
1
0
Fork 0
mirror of https://github.com/lvgl/lvgl.git synced 2026-05-22 07:02:05 +08:00
Code Issues Actions 48 Packages Projects Releases Wiki Activity

docs(API/index.rst): eliminate Sphinx warnings when...

Browse Source 
...the `skip_api` option is used.
This commit is contained in:
Victor Wheeler
2025-06-20 15:17:59 -06:00
committed by Gabor Kiss-Vamosi
parent c994e5c78e
commit 0829150e56
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/src/API/index.rst
+17
View File
@@ -0,0 +1,17 @@
.. _api placeholder:
***************
API Placeholder
***************
This document is here merely as a placeholder so it's LACK of presence when
building the docs like this:
.. code-block:: bash
$ python build.py html skip_api
(which is done in a doc-development/testing environment) does not generate a warning
because this file is not there. When the API portion of the documents DOES get
built, this file is replaced with one programmatically generated by ``build.py``
making calls on ``api_doc_builder.py`` and ``doxygen_xml.py`` modules.