Skip to content

Commit

Permalink
doc-rst: add an option to ignore DocBooks when generating docs
Browse files Browse the repository at this point in the history
Sometimes, we want to do a partial build, instead of building
everything. However, right now, if one wants to build just
Sphinx books, it will build also the DocBooks.

Add an option to allow to ignore all DocBooks when building
documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Mauro Carvalho Chehab authored and Jonathan Corbet committed Jul 10, 2016
1 parent fb054c5 commit 5472188
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Documentation/DocBook/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.

ifeq ($(IGNORE_DOCBOOKS),)

DOCBOOKS := z8530book.xml device-drivers.xml \
kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
writing_usb_driver.xml networking.xml \
Expand Down Expand Up @@ -215,6 +217,20 @@ silent_gen_xml = :
-e "s/>/\\&gt;/g"; \
echo "</programlisting>") > $@

else

# Needed, due to cleanmediadocs
include Documentation/DocBook/media/Makefile

htmldocs:
pdfdocs:
psdocs:
xmldocs:
installmandocs:

endif # IGNORE_DOCBOOKS


###
# Help targets as used by the top-level makefile
dochelp:
Expand All @@ -229,6 +245,9 @@ dochelp:
@echo
@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
@echo ' valid values for DOCBOOKS are: $(DOCBOOKS)'
@echo
@echo " make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook"
@echo ' This is useful to generate only the ReST docs (Sphinx)'


###
Expand Down

0 comments on commit 5472188

Please sign in to comment.