search

lcm-proj / lcm

Lightweight Communications and Marshalling
GNU Lesser General Public License v2.1
944 stars 385 forks source link

API references for C/C++ now missing #419

Closed bluesquall closed 1 year ago

bluesquall commented 1 year ago

At a glance, I'm guessing this is related to 9cc6b1b. The documentation for the C/C++ API (and I think the java API as well) used to be available at https://lcm-proj.github.io, but now that only has the Python and Lua API references.

I like the new Read the Docs style sphinx-generated documentation, but please preserve the base API references somehow, even if it's just a Doxygen-generated subdirectory on the new site.

judfs commented 1 year ago

It seems https://lcm-proj.github.io/lcm/doxygen_output/c_cpp/html/group__LcmCpp.html can be found in links on https://lcm-proj.github.io/lcm/content/tutorial-cpp.html , but it is indeed missing from the "APIS" section in the sidebar.

Also clicking "Home" on the doxygen page takes you to a dead end right now.

nosracd commented 1 year ago

At a glance, I'm guessing this is related to 9cc6b1b. The documentation for the C/C++ API (and I think the java API as well) used to be available at https://lcm-proj.github.io, but now that only has the Python and Lua API references.

I like the new Read the Docs style sphinx-generated documentation, but please preserve the base API references somehow, even if it's just a Doxygen-generated subdirectory on the new site.

@bluesquall I added 4f2ef75f4a288109de065dc8fa616c75f73b4c82 to trick sphinx into adding those external APIs to the toctree; they should now show up on the left pane now.

It seems https://lcm-proj.github.io/lcm/doxygen_output/c_cpp/html/group__LcmCpp.html can be found in links on https://lcm-proj.github.io/lcm/content/tutorial-cpp.html , but it is indeed missing from the "APIS" section in the sidebar.

Also clicking "Home" on the doxygen page takes you to a dead end right now.

@judfs da66f5e2ed870d9ec602b39c75d4b1e3c296948d clobbers the doxygen index.html with a redirect so that the home button should now take you back to the main docs page.

bluesquall commented 1 year ago

Thanks for addressing this issue so quickly. I can see the API documentation online now without having to build it locally.