Re: [RFC 1/5] doc: replace doxygen with hawkmoth sphinx extension for api docs

Subject: Re: [RFC 1/5] doc: replace doxygen with hawkmoth sphinx extension for api docs

Date: Wed, 13 Oct 2021 12:02:40 +0300

To: Tomi Ollila, notmuch@notmuchmail.org

Cc:

From: Jani Nikula


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
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: