From: Floris Bruynooghe <flub@devork.be>
To: David Bremner <david@tethera.net>,
David Bremner <david@tethera.net>,
notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: set up for autoapi / readthedocs compatibility
Date: Tue, 14 Jul 2020 23:42:40 +0200 [thread overview]
Message-ID: <87lfjlbwof.fsf@powell.devork.be> (raw)
In-Reply-To: <20200712120218.1798481-1-david@tethera.net>
On Sun 12 Jul 2020 at 09:02 -0300, David Bremner wrote:
> sphinx-autoapi seems nicer conceptually (it parses the docs rather
> than importing them),
TIL about sphinx-autoapi, agree it's nicer conceptually.
> but it also generates a ton of warnings, so
> leave the default as autodoc.
> ---
>
> You can see the results of this (for now) at https://notmuch.readthedocs.io/en/rtdtest/
> We'd presumable want to integrate the whole tree somehow into notmuchmail.org
Saldy it seems to struggle with a fair bit of things. E.g. it does
manage to create a Database.MODE attribute, but it doesn't figure out
that this is the Mode enum and thus doesn't document the fact you have
two options: MODE.READ_ONLY and MODE.READ_WRITE. There are obviously a
bunch of other enums where this matters.
It could be that these things are solvable by using more autodoc-style
directives:
https://sphinx-autoapi.readthedocs.io/en/latest/reference/directives.html
But I wonder if the autodoc one will always be better because of the
dynamic nature. E.g. mapping notmuch2._database.Mode to
notmuch2.Database.MODE on the actual Public API.
I didn't actually try out how much better autodoc does, I should
probably try that too before commenting further.
next prev parent reply other threads:[~2020-07-14 21:43 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-11 13:20 [PATCH 1/2] doc: replace use of environment variables with a generated config David Bremner
2020-07-11 13:20 ` [PATCH 2/2] doc: add new python bindings to main documentatation tree David Bremner
2020-07-12 12:02 ` [PATCH] doc: set up for autoapi / readthedocs compatibility David Bremner
2020-07-14 21:42 ` Floris Bruynooghe [this message]
2020-07-15 11:53 ` David Bremner
2020-07-14 21:21 ` [PATCH 2/2] doc: add new python bindings to main documentatation tree Floris Bruynooghe
2020-07-11 14:00 ` [PATCH 1/2] doc: replace use of environment variables with a generated config Tomi Ollila
2020-07-14 21:43 ` Floris Bruynooghe
2020-07-15 12:28 ` David Bremner
2020-07-15 12:36 ` [PATCH] configure: replace multiple redirects with redirected block David Bremner
2020-07-18 15:00 ` David Bremner
2020-07-14 21:15 ` [PATCH 1/2] doc: replace use of environment variables with a generated config Floris Bruynooghe
2020-07-17 10:07 ` Tomi Ollila
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=87lfjlbwof.fsf@powell.devork.be \
--to=flub@devork.be \
--cc=david@tethera.net \
--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).