[RFC 0/5] doc: api docs overhaul

Subject: [RFC 0/5] doc: api docs overhaul

Date: Tue, 12 Oct 2021 21:51:22 +0300

To: notmuch@notmuchmail.org

Cc: jani@nikula.org

From: Jani Nikula

I have a pet project to incorporate C documentation comments written in
reStructuredText to Sphinx based documentation [1]. For Notmuch needs,
it replaces Doxygen with something that directly integrates with Sphinx
through an extension.

I've split the series to configure/build changes, functional code
changes in notmuch.h, and comment changes in notmuch.h.

With this, the 'make sphinx-html' build includes the API, with
cross-references working across the man pages, etc. We didn't have this

The main downside is that Hawkmoth is not available via distro
packaging, only PyPI.


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

Jani Nikula (5):
  doc: replace doxygen with hawkmoth sphinx extension for api docs
  lib: remove enum names from typedefs
  lib: remove commented out NOTMUCH_DEPRECATED()
  lib: remove #ifndef __DOXYGEN__ conditions
  lib: documentation comment overhaul for hawkmoth

 configure            |   27 +-
 doc/.gitignore       |    1 -
 doc/Makefile.local   |   54 +-
 doc/conf.py          |   13 +
 doc/doxygen.cfg      |  298 -------
 doc/index.rst        |    1 +
 doc/man3/notmuch.rst |    5 +
 lib/notmuch.h        | 1986 +++++++++++++++++++++++-------------------
 8 files changed, 1131 insertions(+), 1254 deletions(-)
 delete mode 100644 doc/doxygen.cfg
 create mode 100644 doc/man3/notmuch.rst

notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org