Skip to contentSkip to conversation

kernel docs: Fast sphinx-build iteration question

DISCUSSION Breno Leitao 3 participants 3 messages Oct 26, 2023 Documentation

lore
Share & tools
lore
#0 lore raw

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!

maintainer
#1 lore raw
Quoted 8 lines · 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?

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

jon

#2 lore raw
In reply to Breno Leitao
Quoted 8 lines · 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?

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.

Signature · 1 line
Jani Nikula, Intel