From c40a8d5904c29046f1cbbeb998e6cd7c24f9b206 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Tue, 26 May 2020 19:14:48 +0200 Subject: sphinx: add initial build infrastructure Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. (From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/.gitignore | 1 + documentation/Makefile.sphinx | 20 ++++++++++++++++ documentation/conf.py | 55 +++++++++++++++++++++++++++++++++++++++++++ documentation/index.rst | 11 +++++++++ 4 files changed, 87 insertions(+) create mode 100644 documentation/.gitignore create mode 100644 documentation/Makefile.sphinx create mode 100644 documentation/conf.py create mode 100644 documentation/index.rst 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 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile.sphinx + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile.sphinx + @$(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 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'The Yocto Project' +copyright = '2020, The Linux Foundation' +author = 'The Linux Foundation' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# master document name. The default changed from contents to index. so better +# set it ourselves. +master_doc = 'index' + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +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 @@ +.. The Yocto Project documentation master file, created by + sphinx-quickstart on Mon Apr 13 09:38:33 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to The Yocto Project's documentation! +============================================= + +.. toctree:: + :maxdepth: 1 + -- cgit v1.2.3-54-g00ecf