From 59f45624074005342509d0f1ec09fa55bc275734 Mon Sep 17 00:00:00 2001 From: Peter Akers Date: Mon, 10 Jun 2024 14:37:12 +1000 Subject: [PATCH] test 2 --- .gitignore | 3 +++ docs/CMakeLists.txt | 22 ++++++++++++++++++++++ docs/conf.py | 16 ++++++++-------- requirements.txt => docs/requirements.txt | 0 4 files changed, 33 insertions(+), 8 deletions(-) create mode 100644 docs/CMakeLists.txt rename requirements.txt => docs/requirements.txt (100%) diff --git a/.gitignore b/.gitignore index cff0d70..6ba66b3 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,6 @@ # Emacs backup files *~ .vscode/c_cpp_properties.json + +#doco +docs/_build/* diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 0000000..df1310b --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,22 @@ +find_package(Doxygen) + +if(DOXYGEN_FOUND) + message("Found Doxygen") + set(DOXYGEN_IN ${CMAKE_CURRENT_LIST_DIR}/Doxyfile.in) + set(DOXYGEN_OUT ${CMAKE_BINARY_DIR}/Doxyfile.out) + + # request to configure the file + configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY) + message("Doxygen build started") + + # Note: do not put "ALL" - this builds docs together with application EVERY + # TIME! + add_custom_target( + docs + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT} + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Generating API documentation with Doxygen" + VERBATIM) +else() + message("Doxygen need to be installed to generate the doxygen documentation") +endif() diff --git a/docs/conf.py b/docs/conf.py index 0480388..47b393b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,9 +13,9 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'DCCEXProtocol' -copyright = '2023 - Peter Cole, Peter Akers' -author = 'Peter Cole, Peter Akers' +project = 'WithrottleProtocol' +copyright = '2023 - lucadentella, Peter Akers' +author = 'Peter Akers' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -70,8 +70,8 @@ html_context = { 'display_github': True, - 'github_user': 'DCC-EX', - 'github_repo': 'dccexprotocol', + 'github_user': 'flash62au', + 'github_repo': 'WiThrottleProtocol', 'github_version': 'sphinx/docs/', } @@ -81,7 +81,7 @@ ] # Sphinx sitemap -html_baseurl = 'https://dcc-ex.com/DCCEXProtocol/' +html_baseurl = 'https://flash62au.github.io/WiThrottleProtocol/' html_extra_path = [ 'robots.txt', ] @@ -89,7 +89,7 @@ # -- Breathe configuration ------------------------------------------------- breathe_projects = { - "DCCEXProtocol": "_build/xml/" + "WiThrottleProtocol": "./_build/xml/" } -breathe_default_project = "DCCEXProtocol" +breathe_default_project = "WiThrottleProtocol" breathe_default_members = () diff --git a/requirements.txt b/docs/requirements.txt similarity index 100% rename from requirements.txt rename to docs/requirements.txt