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 <ch@denx.de>
This commit is contained in:
Claudius Heine 2017-06-28 14:48:51 +02:00 committed by Daniel Wagner
parent 7ae7fcdb79
commit 730733fcc9
3 changed files with 6 additions and 6 deletions

View File

@ -21,7 +21,6 @@
# #
import os import os
import sys import sys
from recommonmark.parser import CommonMarkParser
# Add the project directory to the path, in order to include it: # 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__), ".."))) 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: # You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md'] source_suffix = ['.rst']
# The encoding of source files. # The encoding of source files.
# #
# source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
source_parsers = {
'.md': CommonMarkParser,
}
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'

View File

@ -11,12 +11,14 @@ project configuration file and does the download and configuration
phase. phase.
Currently supported Yocto versions: Currently supported Yocto versions:
- 2.1 (Krogoth) - 2.1 (Krogoth)
- 2.2 (Morty) - 2.2 (Morty)
Older or newer versions may work as well but haven't been tested intensively. Older or newer versions may work as well but haven't been tested intensively.
Key features provided by the build tool: Key features provided by the build tool:
- clone and checkout bitbake layers - clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...) - create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination - launch minimal build environment, reducing risk of host contamination

3
requirements_rtd.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx>=1.2.0
CommonMark>=0.5.6
sphinx-argparse>=0.2.1