Skip to content

Commit

Permalink
Merge pull request #154 from NOAA-EMC/bugfix/pdoc
Browse files Browse the repository at this point in the history
python documentation and automatic deployment
  • Loading branch information
jbathegit authored Aug 2, 2021
2 parents 14cb6de + 05c40b2 commit 9408871
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ meteorological data.
Please see the [Related Pages](pages.html) tab for more details on this library,
including a comprehensive user guide.

The python API documentation is available [here](python/index.html)

This library is part of the
[NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) project.
4 changes: 2 additions & 2 deletions python/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ if(ENABLE_DOCS)
# Uses pdoc (https://github.com/BurntSushi/pdoc)
find_program(PDOC_EXECUTABLE pdoc REQUIRED)
install(CODE "message(\"Building Python API documentation:
${PDOC_EXECUTABLE} --html --html-no-source --overwrite --html-dir ../docs/python' ncepbufr\")
${PDOC_EXECUTABLE} -o ../docs/html/python' ./ncepbufr\")
set(ENV{PYTHONPATH} ${_install_dir})
execute_process(COMMAND ${PDOC_EXECUTABLE} --html --html-no-source --overwrite --html-dir ../docs/python ncepbufr
execute_process(COMMAND ${PDOC_EXECUTABLE} -o ../docs/html/python ./ncepbufr
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})")
endif()

Expand Down

0 comments on commit 9408871

Please sign in to comment.