[v3] Better handle dependencies on Sphinx extensions

[PATCH v3 0/6] Better handle dependencies on Sphinx extensions

Posted by Mauro Carvalho Chehab 4 years, 2 months ago

Sphinx has its own way to identify the need of rebuilding the documentation.
It means that extensions need to use an internal API in order to notify about
the need to consider other files.

The kerneldoc.py extension already does that, maintainers_include.py doesn't
need (as it uses an API that internally does that), and kfigure.py does it on a
different way.  So, those are already safe.

However, other extensions don't notify nor implement their own checks,
so, when a file that was parsed by them is changed, the corresponding 
documentation won't be rebuilt.

This series add support for it for ABI, features and kernel-include.

---

v3:
  - Changed the meta-tag used when --enable-lineno and --enable-fname
    are used at the scripts that generate ReST output.

Mauro Carvalho Chehab (6):
  scripts/get_feat.pl: allow output the parsed file names
  docs: kernel_feat.py: add build dependencies
  docs: kernel_abi.py: add sphinx build dependencies
  docs: kernel_include.py: add sphinx build dependencies
  scripts/get_abi: change the file/line number meta info
  scripts/kernel-doc: change the line number meta info

 Documentation/sphinx/kernel_abi.py     |  6 +++++-
 Documentation/sphinx/kernel_feat.py    | 20 ++++++++++++++++++--
 Documentation/sphinx/kernel_include.py |  3 +++
 Documentation/sphinx/kerneldoc.py      |  2 +-
 scripts/get_abi.pl                     |  4 ++--
 scripts/get_feat.pl                    | 11 +++++++++++
 scripts/kernel-doc                     |  4 ++--
 7 files changed, 42 insertions(+), 8 deletions(-)

-- 
2.35.1

Re: [PATCH v3 0/6] Better handle dependencies on Sphinx extensions

Posted by Jonathan Corbet 4 years, 2 months ago

Mauro Carvalho Chehab <mchehab@kernel.org> writes:

> Sphinx has its own way to identify the need of rebuilding the documentation.
> It means that extensions need to use an internal API in order to notify about
> the need to consider other files.
>
> The kerneldoc.py extension already does that, maintainers_include.py doesn't
> need (as it uses an API that internally does that), and kfigure.py does it on a
> different way.  So, those are already safe.
>
> However, other extensions don't notify nor implement their own checks,
> so, when a file that was parsed by them is changed, the corresponding 
> documentation won't be rebuilt.
>
> This series add support for it for ABI, features and kernel-include.

Series applied, thanks.

jon