diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-03 17:56:43 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | 54d38a91e109cda79e5b19bc2965f8a73a468fbc (patch) | |
tree | 3b2101eec247d0034825ba8176f3846c77fa2d99 | |
parent | 44e8d439aa57973437ea0f9d7ee60b8f55df9dd1 (diff) | |
download | poky-54d38a91e109cda79e5b19bc2965f8a73a468fbc.tar.gz |
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/boilerplate.rst | 34 | ||||
-rw-r--r-- | documentation/conf.py | 2 |
2 files changed, 35 insertions, 1 deletions
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 @@ | |||
1 | .. include:: <xhtml1-lat1.txt> | ||
2 | .. include:: <xhtml1-symbol.txt> | ||
3 | |||
4 | | |project_name| | ||
5 | | Copyright |copy| |copyright| | ||
6 | | <docs@lists.yoctoproject.org> | ||
7 | |||
8 | Permission is granted to copy, distribute and/or modify this document under the | ||
9 | terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales | ||
10 | <http://creativecommons.org/licenses/by-sa/2.0/uk/>`_ as published by Creative | ||
11 | Commons. | ||
12 | |||
13 | .. note:: | ||
14 | |||
15 | * This version of this *manual* is for the |YOCTO_DOC_VERSION| release of the | ||
16 | Yocto Project. To be sure you have the latest version of the manual for this | ||
17 | release, go to the :yocto_home:`Yocto Project documentation page <docs>` and | ||
18 | select the manual from that site. Manuals from the site are more up-to-date | ||
19 | than manuals derived from the Yocto Project released TAR files. | ||
20 | |||
21 | * If you located this manual through a web search, the version of the manual | ||
22 | might not be the one you want (e.g. the search might have returned a manual | ||
23 | much older than the Yocto Project version with which you are working). You | ||
24 | can see all Yocto Project major releases by visiting the | ||
25 | :yocto_wiki:`Releases<wiki/Releases>` page. If you need a version of this | ||
26 | manual for a different Yocto Project release, visit the :yocto_home:`Yocto | ||
27 | Project documentation page<docs>` and select the manual set by using the | ||
28 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. | ||
29 | |||
30 | * To report any inaccuracies or problems with this (or any other Yocto | ||
31 | Project) manual, send an email to the Yocto Project documentation mailing | ||
32 | list at ``docs@lists.yoctoproject.org`` or log into the freenode ``#yocto`` | ||
33 | channel. | ||
34 | |||
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'] | |||
43 | # List of patterns, relative to source directory, that match files and | 43 | # List of patterns, relative to source directory, that match files and |
44 | # directories to ignore when looking for source files. | 44 | # directories to ignore when looking for source files. |
45 | # This pattern also affects html_static_path and html_extra_path. | 45 | # This pattern also affects html_static_path and html_extra_path. |
46 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | 46 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst'] |
47 | 47 | ||
48 | # master document name. The default changed from contents to index. so better | 48 | # master document name. The default changed from contents to index. so better |
49 | # set it ourselves. | 49 | # set it ourselves. |