From: Jani Nikula <jani@nikula.org>
To: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org
Subject: Re: [RFC 1/5] doc: replace doxygen with hawkmoth sphinx extension for api docs
Date: Wed, 13 Oct 2021 12:02:40 +0300 [thread overview]
Message-ID: <87ily11emn.fsf@nikula.org> (raw)
In-Reply-To: <m2k0ihcueb.fsf@guru.guru-group.fi>
On Wed, 13 Oct 2021, Tomi Ollila <tomi.ollila@iki.fi> wrote:
> Interesting stuff...
>
> On Tue, Oct 12 2021, Jani Nikula wrote:
>
>> Hawkmoth is a Sphinx extension for incorporating documentation
>> comments from C source to Sphinx. For Notmuch API documentation needs,
>> Doxygen is overkill, and Hawkmoth also directly integrates with
>> Sphinx.
>
> // stuff deleted //
>
>> +
>> # -- Options for HTML output ----------------------------------------------
>>
>> # The theme to use for HTML and HTML Help pages. See the documentation for
>> @@ -172,6 +178,13 @@ man_pages = [
>> [notmuch_authors], 1),
>> ]
>>
>> +if tags.has('WITH_API_DOCS'):
>> + man_pages += [
>> + ('man3/notmuch', 'notmuch',
>> + u'notmuch library',
>
> öld stuff...??? (the u'' i mean) :O
Yeah, it's still used throughout in man_pages, decided to follow suit
instead of making that cleanup now.
BR,
Jani.
>
> Tomi
>
>
>> + [notmuch_authors], 3),
>> + ]
>> +
>> # If true, show URL addresses after external links.
>> #man_show_urls = False
next prev parent reply other threads:[~2021-10-13 9:02 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-12 18:51 [RFC 0/5] doc: api docs overhaul Jani Nikula
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 [this message]
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=87ily11emn.fsf@nikula.org \
--to=jani@nikula.org \
--cc=notmuch@notmuchmail.org \
--cc=tomi.ollila@iki.fi \
/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).