linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Breno Leitao <leitao@debian.org>, linux-doc@vger.kernel.org
Cc: mchehab@kernel.org, akiyks@gmail.com, keescook@chromium.org
Subject: Re: kernel docs: Fast sphinx-build iteration question
Date: Thu, 26 Oct 2023 08:07:24 -0600	[thread overview]
Message-ID: <871qdh8okj.fsf@meer.lwn.net> (raw)
In-Reply-To: <ZTpvO3tGOkuq3Q9Q@gmail.com>

Breno Leitao <leitao@debian.org> writes:

> I am working to build a sphinx extension in order to parse some network
> netlink YAML.
>
> I am struggling with the time it takes for sphinx-build to build a
> single file and run my extension (Directive). Mainly because I need to
> remove the `.doctrees` cache directory.
>
> Is there an faster way to iterate while writing an extension?

"make SPHINXDIRS=dir-of-interest" can help a lot.  Otherwise it's just
painful, sorry...

jon

  reply	other threads:[~2023-10-26 14:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-26 13:52 kernel docs: Fast sphinx-build iteration question Breno Leitao
2023-10-26 14:07 ` Jonathan Corbet [this message]
2023-10-26 14:59 ` Jani Nikula

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=871qdh8okj.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=akiyks@gmail.com \
    --cc=keescook@chromium.org \
    --cc=leitao@debian.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab@kernel.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.
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 NNTP newsgroup(s).