add C, C++, C#/.NET, and Java APIs to API toctree

Use a placeholder .rst that to trick sphinx into generating good links. Update the build priority so the APIs build last.
lcm-proj · Mar 16, 2023 · 4f2ef75 · 4f2ef75
1 parent da66f5e
commit 4f2ef75
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 4 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -33,7 +33,7 @@ add_custom_target(doc-doxygen
           ${lcm_SOURCE_DIR}/docs/redirect.html
           ${lcm_BINARY_DIR}/docs/_build/doxygen_output/c_cpp/html/index.html
   WORKING_DIRECTORY ${lcm_SOURCE_DIR}/docs
-  DEPENDS doc-setup)
+  DEPENDS doc-setup doc-sphinx)
 
 add_custom_target(doc-dotnet
   COMMAND ${CMAKE_COMMAND} -E make_directory ${lcm_BINARY_DIR}/docs/_build/doxygen_output/
@@ -54,6 +54,6 @@ endif()
 add_custom_target(doc-sphinx
   COMMAND "PYTHONPATH=${CMAKE_BINARY_DIR}/python" ${SPHINX_EXECUTABLE} ${lcm_SOURCE_DIR}/docs ${lcm_BINARY_DIR}/docs/_build
   WORKING_DIRECTORY ${lcm_SOURCE_DIR}/docs
-  DEPENDS doc-setup doc-dotnet doc-doxygen doc-java lcm-python lcm-python-init)
+  DEPENDS doc-setup lcm-python lcm-python-init)
 
-add_dependencies(doc doc-sphinx)
+add_dependencies(doc doc-dotnet doc-doxygen doc-java )
diff --git a/docs/doxygen_output/c_cpp/html/group__LcmC.rst b/docs/doxygen_output/c_cpp/html/group__LcmC.rst
@@ -0,0 +1,5 @@
+C API
+=====
+
+This is a placeholder to trick sphinx so that it will create links to an external file that will
+exist later.
diff --git a/docs/doxygen_output/c_cpp/html/group__LcmCpp.rst b/docs/doxygen_output/c_cpp/html/group__LcmCpp.rst
@@ -0,0 +1,5 @@
+C++ API
+=======
+
+This is a placeholder to trick sphinx so that it will create links to an external file that will
+exist later.
diff --git a/docs/doxygen_output/lcm-dotnet/html/namespaces.rst b/docs/doxygen_output/lcm-dotnet/html/namespaces.rst
@@ -0,0 +1,5 @@
+C#/.NET API
+===========
+
+This is a placeholder to trick sphinx so that it will create links to an external file that will
+exist later.
diff --git a/docs/index.rst b/docs/index.rst
@@ -144,6 +144,10 @@ sending a message to the `mailing list <http://groups.google.com/group/lcm-users
    :caption: APIs
    :glob:
 
+   doxygen_output/c_cpp/html/group__LcmC
+   doxygen_output/c_cpp/html/group__LcmCpp
+   doxygen_output/lcm-dotnet/html/namespaces
+   javadocs/index
    content/lua-api.md
    python/index.rst
 

diff --git a/docs/javadocs/index.rst b/docs/javadocs/index.rst
@@ -0,0 +1,5 @@
+Java API
+========
+
+This is a placeholder to trick sphinx so that it will create links to an external file that will
+exist later.
diff --git a/lcm-java/CMakeLists.txt b/lcm-java/CMakeLists.txt
@@ -109,6 +109,6 @@ add_custom_target(doc-java
     -link http://docs.oracle.com/javase/8/docs/api/
     ${lcm_java_doc_classes}
   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-  DEPENDS doc-setup)
+  DEPENDS doc-setup doc-sphinx)
 
 add_dependencies(doc doc-java)