[meta-freescale] [Documentation][PATCH 19/31] RN: Add a 'draft' flag so we can warn reader it is not finished yet
Daiane Angolini
daiane.list at gmail.com
Fri Oct 24 18:15:02 PDT 2014
From: Otavio Salvador <otavio at ossystems.com.br>
Signed-off-by: Otavio Salvador <otavio at ossystems.com.br>
---
release-notes/Makefile | 2 +-
release-notes/source/conf.py | 3 +++
release-notes/source/introduction.rst | 13 ++++++++++++-
3 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/release-notes/Makefile b/release-notes/Makefile
index ea6da67..d0dc45a 100644
--- a/release-notes/Makefile
+++ b/release-notes/Makefile
@@ -2,7 +2,7 @@
#
# You can set these variables from the command line.
-SPHINXOPTS =
+SPHINXOPTS = -t draft
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
diff --git a/release-notes/source/conf.py b/release-notes/source/conf.py
index 3ee9ecd..beeb81e 100644
--- a/release-notes/source/conf.py
+++ b/release-notes/source/conf.py
@@ -55,6 +55,9 @@ version = 'dizzy'
# The full version, including alpha/beta/rc tags.
release = '1.7'
+if tags.has('draft'):
+ release = release + " (Draft document)"
+
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
diff --git a/release-notes/source/introduction.rst b/release-notes/source/introduction.rst
index dd8f612..3d64ed2 100644
--- a/release-notes/source/introduction.rst
+++ b/release-notes/source/introduction.rst
@@ -7,7 +7,18 @@ This document has the release notes of the |project_name| |release|
which is a community effort to improve Freescale's SoCs support in the
OpenEmbedded and Yocto Project projects.
-What the |project_name| is
+.. only:: draft
+
+ .. warning::
+
+ This document is still in **draft** stage and *shouldn't be
+ considered finished*. In case you wish to contribute with
+ suggestions, fixes or comments please get in touch through the
+ `meta-freescale
+ <https://lists.yoctoproject.org/listinfo/meta-freescale>`_
+ mailing list.
+
+What is the |project_name|
==========================
The |project_name| is a community-driven project to provide and
maintain Board Support Package (BSP) metadata layers for use in the
--
1.9.1
More information about the meta-freescale
mailing list