Fix documentation building
parent
8566f9d57d
commit
6218a5cc7e
|
|
@ -41,7 +41,7 @@ if(LIBICSNEO_BUILD_DOCS)
|
|||
if(DOXYGEN_FOUND)
|
||||
message("Will build Doxygen based documentation")
|
||||
|
||||
add_custom_target(libicsneo_doxygen ALL
|
||||
add_custom_target(libicsneo_doxygen
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
||||
COMMENT "Generating API documentation with Doxygen"
|
||||
|
|
@ -69,7 +69,7 @@ if(LIBICSNEO_BUILD_DOCS)
|
|||
"${ICSNEO_DOCS_DIR}/conf.py"
|
||||
@ONLY)
|
||||
|
||||
add_custom_target(libicsneo_sphinx
|
||||
add_custom_target(libicsneo_sphinx ALL
|
||||
${SPHINX_EXECUTABLE}
|
||||
-q -b html
|
||||
-c "${ICSNEO_DOCS_DIR}"
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Additionally, `event callbacks`_ can be registered, which may remove the need to
|
|||
|
||||
.. _events:
|
||||
|
||||
Events
|
||||
Events
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The API stores events in a single buffer that can has a default size of 10,000 events.
|
||||
|
|
@ -67,7 +67,7 @@ In order to access device functionality, the device must first be opened, which
|
|||
The exception to this is setting the message polling status of the device.
|
||||
Trying to open/close the device when the device is already open/closed will result in an error being logged on the calling thread.
|
||||
|
||||
Online/Offline Status
|
||||
Online/Offline Status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Going online begins communication between the device and the rest of the network. In order to be online, the device must also be open.
|
||||
|
|
@ -99,4 +99,4 @@ Write Blocking Status
|
|||
|
||||
The write blocking status of the device determines the behavior of attempting to transmit to the device (likely via sending messages) with a large backlog of messages.
|
||||
If write blocking is enabled, then the transmitting thread will wait for the entire buffer to be transmitted.
|
||||
If write blocking is disabled, then the attempt to transmit will simply fail and an error will be logged on the calling thread.
|
||||
If write blocking is disabled, then the attempt to transmit will simply fail and an error will be logged on the calling thread.
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ master_doc = 'index'
|
|||
|
||||
# General information about the project.
|
||||
project = 'libicsneo'
|
||||
copyright = '2019, Intrepid Control Systems, Inc'
|
||||
copyright = '2018-2020, Intrepid Control Systems, Inc.'
|
||||
author = 'Intrepid Control Systems, Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
breathe>=4.11.0
|
||||
breathe==4.12.0
|
||||
Loading…
Reference in New Issue