Documentation: Add support for building with Sphinx

Hardware / Coreboot - Jonathan Neuschäfer [gmx.net] - 26 April 2018 12:25 EDT

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

5e48c75fca Documentation: Add support for building with Sphinx
.gitignore | 1 +
Documentation/Makefile | 8 +-
Documentation/Makefile.sphinx | 225 ++++++++++++++++++++++++++++++++++++++++++
Documentation/conf.py | 182 ++++++++++++++++++++++++++++++++++
Documentation/index.md | 21 ++++
5 files changed, 436 insertions(+), 1 deletion(-)

Upstream: review.coreboot.org


  • Share