diff options
| author | Jonathan Neuschäfer <j.neuschaefer@gmx.net> | 2018-04-19 16:23:56 +0200 |
|---|---|---|
| committer | Patrick Georgi <pgeorgi@google.com> | 2018-04-26 12:25:03 +0000 |
| commit | 5e48c75fcad523fc6602cc2e23fe4a6324e87c5b (patch) | |
| tree | f6abc4eb33b227a90d41bc6b6b5e97a2591405fd /Documentation/Makefile | |
| parent | e361ac9fa89d6726418d0d2b2d3d6e1fa2773ceb (diff) | |
Documentation: Add support for building with Sphinx
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 <j.neuschaefer@gmx.net>
Reviewed-on: https://review.coreboot.org/25787
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index ecfbdb4c59..b5f97d1975 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 |