MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

sphinx: add boilerplate file

Browse Source 
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>
This commit is contained in:
Nicolas Dechesne 2020-07-03 17:56:43 +02:00 committed by Richard Purdie
parent 44e8d439aa
commit 54d38a91e1
2 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
documentation/boilerplate.rst Normal file
View File

@ -0,0 +1,34 @@
.. include:: <xhtml1-lat1.txt>
.. include:: <xhtml1-symbol.txt>
| |project_name|
| Copyright |copy| |copyright|
| <docs@lists.yoctoproject.org>
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
<http://creativecommons.org/licenses/by-sa/2.0/uk/>`_ 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 <docs>` 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<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<docs>` 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.

2
documentation/conf.py
View File

@ -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.