Skip to content

Commit

Permalink
sphinx: add '-w file' (Write warnings (and errors) to the given file)
Browse files Browse the repository at this point in the history
when we are building, capture warnings to a file, so we can check it on
the CI, and it doesn't get lost in the log unchecked.

Also turn on '-n', which runs in nit-picky mode, generating warnings
for all missing references.

Signed-off-by: Robin Getz <[email protected]>
  • Loading branch information
rgetz committed May 13, 2020
1 parent d2b9ff6 commit 27eaac3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions bindings/python/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ if(WITH_DOC)
add_custom_command(TARGET libiio-py POST_BUILD
COMMAND ${SPHINX_EXECUTABLE}
-b html
-n
-c ${CMAKE_CURRENT_SOURCE_DIR}/doc
-d ${CMAKE_CURRENT_BINARY_DIR}/doctrees
-w ${CMAKE_BINARY_DIR}/Spx_output_python
${CMAKE_CURRENT_SOURCE_DIR}/doc
${CMAKE_HTML_DEST_DIR}/python
COMMENT "Generating Python binding documentation with Sphinx" VERBATIM
Expand Down

0 comments on commit 27eaac3

Please sign in to comment.