Skip to content

Commit

Permalink
test 2
Browse files Browse the repository at this point in the history
  • Loading branch information
flash62au committed Jun 10, 2024
1 parent c8e7a8b commit 59f4562
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@
# Emacs backup files
*~
.vscode/c_cpp_properties.json

#doco
docs/_build/*
22 changes: 22 additions & 0 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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()
16 changes: 8 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/',
}

Expand All @@ -81,15 +81,15 @@
]

# Sphinx sitemap
html_baseurl = 'https://dcc-ex.com/DCCEXProtocol/'
html_baseurl = 'https://flash62au.github.io/WiThrottleProtocol/'
html_extra_path = [
'robots.txt',
]

# -- Breathe configuration -------------------------------------------------

breathe_projects = {
"DCCEXProtocol": "_build/xml/"
"WiThrottleProtocol": "./_build/xml/"
}
breathe_default_project = "DCCEXProtocol"
breathe_default_project = "WiThrottleProtocol"
breathe_default_members = ()
File renamed without changes.

0 comments on commit 59f4562

Please sign in to comment.