kernel docs: Fast sphinx-build iteration question

kernel docs: Fast sphinx-build iteration question

[Breno Leitao]

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?

Thank you!

Re: kernel docs: Fast sphinx-build iteration question

[Jonathan Corbet]

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

Re: kernel docs: Fast sphinx-build iteration question

[Jani Nikula]

On Thu, 26 Oct 2023, Breno Leitao <leitao@debian.org> wrote:
> 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?

Develop it as a standalone extension, outside of the kernel tree, and
test using a single page?

Once you're done, add it to kernel.

BR,
Jani.


-- 
Jani Nikula, Intel