[RFC PATCH 0/4] doc: use Hawkmoth for API documentation

Subject:[RFC PATCH 0/4] doc: use Hawkmoth for API documentation

Date:Sun, 20 Aug 2017 22:30:35 +0300

To:notmuch@notmuchmail.org

Cc:

From:Jani Nikula


Hawkmoth [1] is a minimalistic Sphinx C Domain autodoc directive
extension to incorporate formatted C source code comments into Sphinx
based documentation, by yours truly. See commit message of patch 2 for
details.

This series is probably more a real world test case for Hawkmoth than a
serious attempt at getting it merged to Notmuch. Nonetheless, I decided
to post it as food for thought. With hopes that one day it'll be a
serious and compelling alternative for Sphinx based C API documentation.

'make sphinx-html' is probably more interesting than 'make build-man'.

BR,
Jani.


[1] https://github.com/jnikula/hawkmoth


Jani Nikula (4):
  doc: add man section 3 handling
  doc: use hawkmoth for generating libnotmuch api documentation
  lib: fix the biggest hawkmoth offenders in notmuch.h
  lib: add reStructuredText bling for API documentation in notmuch.h

 doc/Makefile.local      |  10 ++--
 doc/conf.py             |  14 +++++
 doc/index.rst           |   1 +
 doc/man3/libnotmuch.rst |  20 +++++++
 lib/notmuch.h           | 139 ++++++++++++++++++++++++++----------------------
 5 files changed, 117 insertions(+), 67 deletions(-)
 create mode 100644 doc/man3/libnotmuch.rst

-- 
2.11.0

_______________________________________________
notmuch mailing list
notmuch@notmuchmail.org
https://notmuchmail.org/mailman/listinfo/notmuch

Thread: