ffe6d54151
Documentation: Disable auto_doc_ref
...
According to recommonmark's documentation the enable_auto_doc_ref is deprecated.
This is not true, as it's broken with Sphinx 1.6+ commit
12d639873953847de31ec99742b42e50e89ed58c.
recommonmark bug report is here: https://github.com/rtfd/recommonmark/issues/73
Instead of using this feature, which doesn't support top level directories in
the relative document path anyway, use the TOC tree or inline RST code.
Disable auto_doc_ref and document how to reference documents.
Change-Id: I9319985b504c4215c33ebbeb9c38317b9efcb283
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com >
Reviewed-on: https://review.coreboot.org/28550
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Tom Hiller <thrilleratplay@gmail.com >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-09-30 03:18:05 +00:00
5eb2115c3d
Documenation/conf.py: Make sure release is a string
...
With python3 the split method can operate on strings while check_output
generates bytestrings.
Change-Id: I7b455c56e8195f0ecfbe5e360ac161c176f00115
Signed-off-by: Arthur Heymans <arthur@aheymans.xyz >
Reviewed-on: https://review.coreboot.org/27630
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-07-26 11:15:56 +00:00
5ce400178a
Documentation: inject the current git revision into the website
...
Change-Id: I79cceca7373f8bdf9bbfba5d84b8fa589afa838b
Signed-off-by: Patrick Georgi <patrick@georgi.software >
Reviewed-on: https://review.coreboot.org/26897
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-06-07 15:10:43 +00:00
89011bec6a
Documentation: Remove whitespace before tab
...
Change-Id: I8cb5b122162c40435f93019c9be9a367d2656cf1
Signed-off-by: Elyes HAOUAS <ehaouas@noos.fr >
Reviewed-on: https://review.coreboot.org/26660
Reviewed-by: Patrick Georgi <pgeorgi@google.com >
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
2018-06-04 11:48:23 +00:00
93ffe83ec2
Documentation: Add markdown license information
...
Add CC-by 4.0 license written in markdown and add global copyright string.
Change-Id: I31dc540d63b289d38d6d7d9a7c35b6bb50f9c92d
Signed-off-by: Patrick Rudolph <siro@das-labor.org >
Reviewed-on: https://review.coreboot.org/26264
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Martin Roth <martinroth@google.com >
2018-06-04 09:31:34 +00:00
a78e66e5f4
Documentation: Add static CSS file to fix tables
...
Add a static CSS file to remove annoying scrollbars on rst code tables.
Change-Id: I436b36fb7ee9856c7d6ad8534cd0610b7f071b17
Signed-off-by: Patrick Rudolph <siro@das-labor.org >
Reviewed-on: https://review.coreboot.org/26263
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com >
2018-05-14 17:21:37 +00:00
57df088816
Dokumentation: Sphinx add RST in markdown support
...
* This feature embedds RST into markdown for
table generation.
For more information, see
http://recommonmark.readthedocs.io/en/latest/index.html#autostructify
Change-Id: Iefebb3b7857bc98818e345f7d0e95fbf987305a8
Signed-off-by: Philipp Deppenwiese <zaolin@das-labor.org >
Reviewed-on: https://review.coreboot.org/26190
Reviewed-by: Patrick Georgi <pgeorgi@google.com >
Tested-by: build bot (Jenkins) <no-reply@coreboot.org >
2018-05-11 08:58:08 +00:00
5e48c75fca
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 >
2018-04-26 12:25:03 +00:00
