From 5e48c75fcad523fc6602cc2e23fe4a6324e87c5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= Date: Thu, 19 Apr 2018 16:23:56 +0200 Subject: Documentation: Add support for building with Sphinx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit adds the necessary infrastructure to convert the Markdown files in the Documentation directory to HTML using Sphinx[1] and recommonmark[2]. I selected "sphinx_rtd_theme" as the theme, because it offers a useful navigation sidebar, and because it's already used for the Linux kernel[3]. Makefile.sphinx was auto-generated by sphinx-quickstart. conf.py was auto-generated and manually adjusted. [1]: http://www.sphinx-doc.org/en/stable/ [2]: https://recommonmark.readthedocs.io/en/latest/ [3]: https://www.kernel.org/doc/html/latest/index.html Change-Id: Ie4de96978e334c598cf5890775807d3e15c29c4d Signed-off-by: Jonathan Neuschäfer Reviewed-on: https://review.coreboot.org/25787 Tested-by: build bot (Jenkins) Reviewed-by: Patrick Georgi --- Documentation/Makefile | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'Documentation/Makefile') diff --git a/Documentation/Makefile b/Documentation/Makefile index ecfbdb4c599a..b5f97d197564 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -63,7 +63,13 @@ socketfkconfig.tex: ../src/cpu/amd/socket_F/Kconfig grep '^config' $< | awk '{print $2}' >>$@ cat endverbatim.tex >> $@ -clean: +sphinx: + $(MAKE) -f Makefile.sphinx html + +clean-sphinx: + $(MAKE) -f Makefile.sphinx clean + +clean: clean-sphinx rm -f *.aux *.idx *.log *.toc *.out $(FIGS) mainboardkconfig.tex skconfig.tex cpukconfig.tex socketfkconfig.tex distclean: clean -- cgit v1.2.3