From 730733fcc9768a4d785702a2569eb49546eae811 Mon Sep 17 00:00:00 2001 From: Claudius Heine Date: Wed, 28 Jun 2017 14:48:51 +0200 Subject: [PATCH] Made project buildable with rtd - removed markdown support for documentation, because of import difficulties. - converted `intro.md` to restructured text `intro.rst` - added requirements_rtd.txt that lists the required packages for rtd to build the documentation. Signed-off-by: Claudius Heine --- docs/conf.py | 7 +------ docs/{intro.md => intro.rst} | 2 ++ requirements_rtd.txt | 3 +++ 3 files changed, 6 insertions(+), 6 deletions(-) rename docs/{intro.md => intro.rst} (99%) create mode 100644 requirements_rtd.txt diff --git a/docs/conf.py b/docs/conf.py index fe2c223..e3999bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,6 @@ # import os import sys -from recommonmark.parser import CommonMarkParser # Add the project directory to the path, in order to include it: sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))) @@ -51,16 +50,12 @@ templates_path = ['_templates'] # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = ['.rst', '.md'] +source_suffix = ['.rst'] # The encoding of source files. # # source_encoding = 'utf-8-sig' -source_parsers = { - '.md': CommonMarkParser, -} - # The master toctree document. master_doc = 'index' diff --git a/docs/intro.md b/docs/intro.rst similarity index 99% rename from docs/intro.md rename to docs/intro.rst index 5bd4fa9..d265744 100644 --- a/docs/intro.md +++ b/docs/intro.rst @@ -11,12 +11,14 @@ project configuration file and does the download and configuration phase. Currently supported Yocto versions: + - 2.1 (Krogoth) - 2.2 (Morty) Older or newer versions may work as well but haven't been tested intensively. Key features provided by the build tool: + - clone and checkout bitbake layers - create default bitbake settings (machine, arch, ...) - launch minimal build environment, reducing risk of host contamination diff --git a/requirements_rtd.txt b/requirements_rtd.txt new file mode 100644 index 0000000..a8d67b1 --- /dev/null +++ b/requirements_rtd.txt @@ -0,0 +1,3 @@ +sphinx>=1.2.0 +CommonMark>=0.5.6 +sphinx-argparse>=0.2.1