From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Cc: jani@nikula.org
Subject: [RFC 0/5] doc: api docs overhaul
Date: Tue, 12 Oct 2021 21:51:22 +0300 [thread overview]
Message-ID: <20211012185127.198348-1-jani@nikula.org> (raw)
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
before.
The main downside is that Hawkmoth is not available via distro
packaging, only PyPI.
BR,
Jani.
[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
--
2.30.2
next reply other threads:[~2021-10-12 18:51 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-12 18:51 Jani Nikula [this message]
2021-10-12 18:51 ` [RFC 1/5] doc: replace doxygen with hawkmoth sphinx extension for api docs Jani Nikula
2021-10-13 6:26 ` Tomi Ollila
2021-10-13 9:02 ` Jani Nikula
2021-10-13 13:21 ` David Bremner
2021-10-12 18:51 ` [RFC 2/5] lib: remove enum names from typedefs Jani Nikula
2021-10-13 13:18 ` David Bremner
2021-10-13 13:28 ` Tomi Ollila
2021-10-13 14:04 ` Jani Nikula
2021-10-12 18:51 ` [RFC 3/5] lib: remove commented out NOTMUCH_DEPRECATED() Jani Nikula
2021-10-13 13:19 ` David Bremner
2021-10-13 14:04 ` Jani Nikula
2021-10-12 18:51 ` [RFC 4/5] lib: remove #ifndef __DOXYGEN__ conditions Jani Nikula
2021-10-12 18:51 ` [RFC 5/5] lib: documentation comment overhaul for hawkmoth Jani Nikula
2021-10-13 12:17 ` [RFC 0/5] doc: api docs overhaul David Bremner
2021-10-13 13:41 ` Jani Nikula
2021-10-13 13:59 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211012185127.198348-1-jani@nikula.org \
--to=jani@nikula.org \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).