remarkable-linux/Documentation/DocBook
Jani Nikula 22cba31bae Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.

At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.

All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.

There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.

If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.

Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.

Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.

This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-30 13:38:51 +03:00
..
media The most interesting thing (IMO) this time around is some beginning 2016-05-19 18:07:25 -07:00
.gitignore
80211.tmpl cfg80211: Add option to report the bss entry in connect result 2016-04-26 09:40:12 +02:00
alsa-driver-api.tmpl ALSA: DocBook: Add soc-ops.c and soc-compress.c 2015-10-28 12:37:50 +01:00
crypto-API.tmpl crypto: doc - document correct return value for request allocation 2016-04-15 22:35:44 +08:00
debugobjects.tmpl Documentation: update debugobjects doc 2016-05-19 19:12:14 -07:00
device-drivers.tmpl Staging and IIO driver update for 4.7-rc1 2016-05-20 22:20:48 -07:00
deviceiobook.tmpl
filesystems.tmpl
gadget.tmpl
genericirq.tmpl
gpu.tmpl Merge tag 'drm-intel-next-fixes-2016-05-25' of git://anongit.freedesktop.org/drm-intel into drm-next 2016-05-27 16:08:38 +10:00
iio.tmpl Doc: Docbook/iio: Fix typo in iio.tmpl 2015-11-20 17:09:05 -07:00
kernel-api.tmpl
kernel-hacking.tmpl
kernel-locking.tmpl
kgdb.tmpl
libata.tmpl
librs.tmpl
lsm.tmpl
Makefile Documentation/sphinx: add basic working Sphinx configuration and build 2016-05-30 13:38:51 +03:00
media_api.tmpl [media] use https://linuxtv.org for LinuxTV URLs 2015-12-04 10:38:59 -02:00
mtdnand.tmpl mtd: nand: update the documentation to reflect framework changes 2015-12-18 11:26:01 -08:00
networking.tmpl
rapidio.tmpl
regulator.tmpl
s390-drivers.tmpl
scsi.tmpl
sh.tmpl
stylesheet.xsl
tracepoint.tmpl
uio-howto.tmpl
usb.tmpl usb: devio: Add ioctl to disallow detaching kernel USB drivers. 2016-03-05 12:05:01 -08:00
w1.tmpl
writing-an-alsa-driver.tmpl ALSA: Remove transfer_ack_{begin,end} callbacks from struct snd_pcm_runtime 2015-10-22 17:16:23 +02:00
writing_musb_glue_layer.tmpl
writing_usb_driver.tmpl
z8530book.tmpl