From 669228f14729f37b295bc40955062f5ae2a8ce29 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Tue, 19 Aug 2025 05:23:46 +0000 Subject: [PATCH] Refactor Sphinx documentation for better structure. This change improves the layout of the Read the Docs documentation by creating a dedicated API reference page. Key changes: - Created a new `docs/api.rst` file to contain all C++ API documentation generated from Doxygen. - Added references to both `MedicalLib/MedicalLib.h` and `MedicalLib/Patient.h` in `api.rst`. - Updated `docs/index.rst` to remove the inline API documentation and include a link to the new `api.rst` page in the `toctree`. This results in a cleaner, more organized, and complete documentation site. --- docs/api.rst | 10 ++++++++++ docs/index.rst | 6 +----- 2 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 docs/api.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..92590da --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,10 @@ +API Reference +============= + +This page contains the auto-generated API reference for the MedicalLib C++ library. + +.. doxygenfile:: MedicalLib/MedicalLib.h + :project: MedicalLib + +.. doxygenfile:: MedicalLib/Patient.h + :project: MedicalLib diff --git a/docs/index.rst b/docs/index.rst index 3ec3068..838f677 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,8 +10,4 @@ Welcome to MedicalLib's documentation! :maxdepth: 2 :caption: Contents: -API Reference -------------- - -.. doxygenfile:: MedicalLib/Patient.h - :project: MedicalLib + api