diff options
author | Chris Kay <chris.kay@arm.com> | 2021-11-09 16:14:36 +0000 |
---|---|---|
committer | Chris Kay <chris.kay@arm.com> | 2021-11-17 16:04:36 +0000 |
commit | c76556a01769dd699c437ac4390b11dec38017c6 (patch) | |
tree | b0b2f053344c669be1fdd0f18e5639b31538c91a /docs/conf.py | |
parent | fa3a13824a8b025cbd69c0efa435892c81734448 (diff) | |
download | arm-trusted-firmware-c76556a01769dd699c437ac4390b11dec38017c6.tar.gz |
build(docs): add support for Markdown documentation
This changes adds support for building Markdown documentation into
Sphinx with [MyST]. We'll make use of this in a later patch, where we
introduce automatically-generated Markdown documentation that needs to
be compiled as part of the Sphinx documentation.
[MyST]: https://myst-parser.readthedocs.io/en/latest
Change-Id: I2a241a588c579fac1a81e1853479908928be1fc8
Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 356be99d6..ef77f6bfe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,13 +20,13 @@ project = 'Trusted Firmware-A' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml'] +extensions = ['myst_parser', 'sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. -source_suffix = '.rst' +source_suffix = ['.md', '.rst'] # The master toctree document. master_doc = 'index' |