From 6218a5cc7ea762b4a3b73ff510fbc73654f5e6cc Mon Sep 17 00:00:00 2001 From: Paul Hollinsky Date: Thu, 6 Aug 2020 16:09:29 -0400 Subject: [PATCH] Fix documentation building --- CMakeLists.txt | 4 ++-- docs/Usage.rst | 6 +++--- docs/conf.py | 2 +- docs/requirements.txt | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 4c62dae..c352c67 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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}" diff --git a/docs/Usage.rst b/docs/Usage.rst index c41bc09..608b3b1 100644 --- a/docs/Usage.rst +++ b/docs/Usage.rst @@ -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. \ No newline at end of file +If write blocking is disabled, then the attempt to transmit will simply fail and an error will be logged on the calling thread. diff --git a/docs/conf.py b/docs/conf.py index 463c94c..6b80a14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/requirements.txt b/docs/requirements.txt index f9a8218..b03ce95 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -breathe>=4.11.0 \ No newline at end of file +breathe==4.12.0 \ No newline at end of file