From 54d38a91e109cda79e5b19bc2965f8a73a468fbc Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Fri, 3 Jul 2020 17:56:43 +0200 Subject: sphinx: add boilerplate file A certain amount of boilerplate is added at the beginning of all documents. In DocBook this is copy/pasted in each file. Let's create a boilerplate ReST file, which we will include in each document, wherever it's required. (From yocto-docs rev: 37e0d5f246c614e62a7c0d4d72a5d6ce9ec5325e) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/boilerplate.rst | 34 ++++++++++++++++++++++++++++++++++ documentation/conf.py | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 documentation/boilerplate.rst (limited to 'documentation') diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst new file mode 100644 index 0000000000..d9cb7a263d --- /dev/null +++ b/documentation/boilerplate.rst @@ -0,0 +1,34 @@ +.. include:: +.. include:: + +| |project_name| +| Copyright |copy| |copyright| +| + +Permission is granted to copy, distribute and/or modify this document under the +terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales +`_ as published by Creative +Commons. + +.. note:: + + * This version of this *manual* is for the |YOCTO_DOC_VERSION| release of the + Yocto Project. To be sure you have the latest version of the manual for this + release, go to the :yocto_home:`Yocto Project documentation page ` and + select the manual from that site. Manuals from the site are more up-to-date + than manuals derived from the Yocto Project released TAR files. + + * If you located this manual through a web search, the version of the manual + might not be the one you want (e.g. the search might have returned a manual + much older than the Yocto Project version with which you are working). You + can see all Yocto Project major releases by visiting the + :yocto_wiki:`Releases` page. If you need a version of this + manual for a different Yocto Project release, visit the :yocto_home:`Yocto + Project documentation page` and select the manual set by using the + "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. + + * To report any inaccuracies or problems with this (or any other Yocto + Project) manual, send an email to the Yocto Project documentation mailing + list at ``docs@lists.yoctoproject.org`` or log into the freenode ``#yocto`` + channel. + diff --git a/documentation/conf.py b/documentation/conf.py index 5519acb87a..a598c5bd88 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -43,7 +43,7 @@ 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'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst'] # master document name. The default changed from contents to index. so better # set it ourselves. -- cgit v1.2.3-54-g00ecf