diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/.gitignore | 1 | ||||
-rw-r--r-- | documentation/Makefile.sphinx | 20 | ||||
-rw-r--r-- | documentation/conf.py | 55 | ||||
-rw-r--r-- | documentation/index.rst | 11 |
4 files changed, 87 insertions, 0 deletions
diff --git a/documentation/.gitignore b/documentation/.gitignore new file mode 100644 index 0000000000..69fa449dd9 --- /dev/null +++ b/documentation/.gitignore | |||
@@ -0,0 +1 @@ | |||
_build/ | |||
diff --git a/documentation/Makefile.sphinx b/documentation/Makefile.sphinx new file mode 100644 index 0000000000..933c77ee5f --- /dev/null +++ b/documentation/Makefile.sphinx | |||
@@ -0,0 +1,20 @@ | |||
1 | # Minimal makefile for Sphinx documentation | ||
2 | # | ||
3 | |||
4 | # You can set these variables from the command line, and also | ||
5 | # from the environment for the first two. | ||
6 | SPHINXOPTS ?= | ||
7 | SPHINXBUILD ?= sphinx-build | ||
8 | SOURCEDIR = . | ||
9 | BUILDDIR = _build | ||
10 | |||
11 | # Put it first so that "make" without argument is like "make help". | ||
12 | help: | ||
13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
14 | |||
15 | .PHONY: help Makefile.sphinx | ||
16 | |||
17 | # Catch-all target: route all unknown targets to Sphinx using the new | ||
18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
19 | %: Makefile.sphinx | ||
20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 0000000000..2afaf81810 --- /dev/null +++ b/documentation/conf.py | |||
@@ -0,0 +1,55 @@ | |||
1 | # Configuration file for the Sphinx documentation builder. | ||
2 | # | ||
3 | # This file only contains a selection of the most common options. For a full | ||
4 | # list see the documentation: | ||
5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
6 | |||
7 | # -- Path setup -------------------------------------------------------------- | ||
8 | |||
9 | # If extensions (or modules to document with autodoc) are in another directory, | ||
10 | # add these directories to sys.path here. If the directory is relative to the | ||
11 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
12 | # | ||
13 | # import os | ||
14 | # import sys | ||
15 | # sys.path.insert(0, os.path.abspath('.')) | ||
16 | |||
17 | |||
18 | # -- Project information ----------------------------------------------------- | ||
19 | |||
20 | project = 'The Yocto Project' | ||
21 | copyright = '2020, The Linux Foundation' | ||
22 | author = 'The Linux Foundation' | ||
23 | |||
24 | |||
25 | # -- General configuration --------------------------------------------------- | ||
26 | |||
27 | # Add any Sphinx extension module names here, as strings. They can be | ||
28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
29 | # ones. | ||
30 | extensions = [ | ||
31 | ] | ||
32 | |||
33 | # Add any paths that contain templates here, relative to this directory. | ||
34 | templates_path = ['_templates'] | ||
35 | |||
36 | # List of patterns, relative to source directory, that match files and | ||
37 | # directories to ignore when looking for source files. | ||
38 | # This pattern also affects html_static_path and html_extra_path. | ||
39 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
40 | |||
41 | # master document name. The default changed from contents to index. so better | ||
42 | # set it ourselves. | ||
43 | master_doc = 'index' | ||
44 | |||
45 | # -- Options for HTML output ------------------------------------------------- | ||
46 | |||
47 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
48 | # a list of builtin themes. | ||
49 | # | ||
50 | html_theme = 'alabaster' | ||
51 | |||
52 | # Add any paths that contain custom static files (such as style sheets) here, | ||
53 | # relative to this directory. They are copied after the builtin static files, | ||
54 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
55 | html_static_path = ['_static'] | ||
diff --git a/documentation/index.rst b/documentation/index.rst new file mode 100644 index 0000000000..1470d2d5de --- /dev/null +++ b/documentation/index.rst | |||
@@ -0,0 +1,11 @@ | |||
1 | .. The Yocto Project documentation master file, created by | ||
2 | sphinx-quickstart on Mon Apr 13 09:38:33 2020. | ||
3 | You can adapt this file completely to your liking, but it should at least | ||
4 | contain the root `toctree` directive. | ||
5 | |||
6 | Welcome to The Yocto Project's documentation! | ||
7 | ============================================= | ||
8 | |||
9 | .. toctree:: | ||
10 | :maxdepth: 1 | ||
11 | |||