Am 06.08.2016 um 14:00 schrieb Mauro Carvalho Chehab <[email protected]>:
> Being able to build just the media docs is important for us due to several
> reasons:
>
> 1) Media developers community hosts a copy of the media documentation at
> linuxtv.org
> with the very latest under development documents;
>
> 2) Nitpicking to identify broken references is important to identify
> documentation gaps
> that need to be addressed on future releases;
>
> 3) As media maintainers check patch per patch if a documentation gap is
> introduced,
Take into account: the gap is detected by "open references" (from the
reST-header
files), but Sphinx tries to bind a ":ref:" to any anchor which fits (no matter
where
it comes from). I mean, if we add more and more content or e.g. interpshinx
objects,
we did not know which targets are available and the risk to get a *false bind*
grows
with the content.
I don't know, may be in some future you will come into trouble, when you want
to refer targets outside of the ./media folder and *detect gaps* in the docs.
This need not be a problem, but you should be aware of, that your "test" is
only a test on open/closed links.
> building
> media documentation should be as fast as possible.
>
> This patchset adds a media file adding nitpick support and an extra build
> target that will
> compile only the media documentation. It also groups all media documentation
> into one
> section on the main Kernel document, with is, IMHO, a good thing as we start
> adding more
> stuff there.
>
> Jon,
>
> I'd love to see this patch merged early at the -rc cycle, in order to avoid
> merge
> conflicts when people start converting other docbooks to Sphinx, as it touches
> at the main Makefile and at the Sphinx common stuff. Also, as I'll need to
> patch my
> build scripts to check for documentation issues with Sphinx, I need them on my
> master branch, as otherwise my workflow will be broken until the next Kernel
> release.
>
> So, If you're ok with this patch series, can you submit to Linus on early
> -rc? Or
> if you prefer, I can do it myself, with your ack.
>
> Thanks!
> Mauro
>
> PS.: I would prefer to have a more generic way to add support to build
> documentation
> for only one subsystem, but, as we also need to load an extra python module
> to be
> able to enable nitpick mode, I opted, for now, on not doing it too generic.
> We can rework
> on it later, as other subsystems would need a similar feature.
Within my POC I called it "books", may it is better to call them
"sphinx-projects",
but for the first and the concept it should good enough to stay with "books" /
see
Makefile.reST [1] ::
# Sphinx projects, we call them *books* which is more common to authors.
BOOKS_FOLDER = $(obj)/Documentation
BOOKS=$(filter-out books/intro, \
$(patsubst $(BOOKS_FOLDER)/%/conf.py,books/%,$(wildcard
$(BOOKS_FOLDER)/*/conf.py)) \
)
# fine grained targets
BOOKS_HTML = $(patsubst %,%.html, $(BOOKS))
BOOKS_CLEAN = $(patsubst %,%.clean, $(BOOKS))
BOOKS_MAN = $(patsubst %,%.man, $(BOOKS))
BOOKS_PDF = $(patsubst %,%.pdf, $(BOOKS))
[1] https://github.com/return42/sphkerneldoc/blob/master/doc/Makefile#L40
In words: A "book" (or sphinx-project) is a folder with a conf.py in
and the "folder-name" is the name of the related target ::
Documentation/*/conf.py
And the selective targets are
make books/[media|...].[html|man|pdf|clean|...]
By example, build only the html of media::
make books/media.html
The integration into the main Makefile is generic by adding the
wildcard target "books%"
modified Makefile
@@ -478,7 +478,7 @@ version_h := include/generated/uapi/linux/version.h
old_version_h := include/linux/version.h
no-dot-config-targets := clean mrproper distclean \
- cscope gtags TAGS tags help% %docs check% coccicheck \
+ cscope gtags TAGS tags help% %docs books% check%
coccicheck \
$(version_h) headers_% archheaders archscripts \
kernelversion %src-pkg
+# more fine grained documentation targets
+books/%:
+ $(Q)$(MAKE) $(build)=Documentation -f Documentation/Makefile.reST $@
+
If you are interested in, I prepare a patch series for the Makefiles and the
conf.py. Any suggestions about the prefix "books"? ... I preferred "books" over
"sphinx-project" or similar, because it is pregnant and short (less to type).
-- Markus --
>
>
> Markus Heiser (1):
> doc-rst: support additional Sphinx build config override
>
> Mauro Carvalho Chehab (2):
> doc-rst: add an option to build media documentation in nitpick mode
> doc-rst: remove a bogus comment from Documentation/index.rst
>
> Documentation/Makefile.sphinx | 10 ++++-
> Documentation/conf.py | 9 ++++
> Documentation/index.rst | 7 +--
> Documentation/media/conf_nitpick.py | 85 +++++++++++++++++++++++++++++++++++++
> Documentation/media/index.rst | 12 ++++++
> Documentation/sphinx/load_config.py | 25 +++++++++++
> Makefile | 6 +++
> 7 files changed, 146 insertions(+), 8 deletions(-)
> create mode 100644 Documentation/media/conf_nitpick.py
> create mode 100644 Documentation/media/index.rst
> create mode 100644 Documentation/sphinx/load_config.py
>
> --
> 2.7.4
>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-media" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
