From 734708616bd216e9645ca795005a158b6aacf7ef Mon Sep 17 00:00:00 2001 From: nick black Date: Sat, 28 Dec 2019 20:11:08 -0500 Subject: [PATCH] html documentation --- CMakeLists.txt | 11 +++++++++++ doc/man/man3/notcurses_init.3.ronn | 2 ++ doc/release-checklist.md | 1 + 3 files changed, 14 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 7ce177b3d..5b028d4b2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -132,6 +132,17 @@ foreach(m ${MANSOURCE3}) DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${me} ) set(MANPAGES3 ${MANPAGES3} ${CMAKE_CURRENT_BINARY_DIR}/${me}) + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${me}.html + DEPENDS ${m} + COMMAND ${RONN} + ARGS -5 --pipe ${m} > ${CMAKE_CURRENT_BINARY_DIR}/${me}.html + COMMENT "Building HTML5 ${me}.html" + ) + add_custom_target(${me}.html + ALL + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${me}.html + ) endforeach() endif() diff --git a/doc/man/man3/notcurses_init.3.ronn b/doc/man/man3/notcurses_init.3.ronn index 72e27fd07..eda4f75f4 100644 --- a/doc/man/man3/notcurses_init.3.ronn +++ b/doc/man/man3/notcurses_init.3.ronn @@ -93,10 +93,12 @@ restricted as to what actions they can perform, so minimal work is perfomed in the handler proper. Thus, in the absence of `no_winch_sighandler`, `SIGWINCH` results in: + * interruption of some thread to process the signal * a `TIOCGWINSZ` `ioctl` to retrieve the new screen size * queuing of a `NCKEY_RESIZE` input event (if there is space in the queue) * blanking of the new screen area (if `clear_screen_start` is set) + Upon the next call to `notcurses_render` or `notcurses_resize`, the standard plane (see `notcurses_stdplane(3)`) will be resized to the new screen size. The next `notcurses_render` call will function as expected across the new screen diff --git a/doc/release-checklist.md b/doc/release-checklist.md index 5f931073e..ce2e4a393 100644 --- a/doc/release-checklist.md +++ b/doc/release-checklist.md @@ -18,6 +18,7 @@ * Test that package builds with `makepkg` * `git commit -a` * Upload new Rust crate with `cargo upload` +* Generate and upload new HTML documentation via `make html` * Update Debian changelog with `dch -v $NEXTVERSION-1` * Update `doc/FreeBSD-Makefile` version * Update CMakeLists.txt with next version