From 5e48c75fcad523fc6602cc2e23fe4a6324e87c5b Mon Sep 17 00:00:00 2001 From: Jonathan Neuschäfer 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 --- .gitignore | 1 + 1 file changed, 1 insertion(+) (limited to '.gitignore') diff --git a/.gitignore b/.gitignore index 7ee954db44..378741f0cd 100644 --- a/.gitignore +++ b/.gitignore @@ -132,5 +132,6 @@ documentation/cpukconfig.tex documentation/mainboardkconfig.tex documentation/skconfig.tex documentation/socketfkconfig.tex +Documentation/_build doxygen/* -- cgit v1.2.3