Add describe of building documantation from schemas
Change-Id: Ib035256bb0820d9c8fd2fd42245b8ab074ad3789
diff --git a/README.rst b/README.rst
index 9348c19..c397d0b 100755
--- a/README.rst
+++ b/README.rst
@@ -3,12 +3,16 @@
Sphinx
======
-Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well.
+Sphinx is a tool that makes it easy to create intelligent and beautiful documentation,
+written by Georg Brandl and licensed under the BSD license. It was originally created
+for the new Python documentation, and it has excellent facilities for the documentation
+of Python projects. The C/C++ projects are already supported as well, and it is planned
+to add special support for other languages as well.
Sample pillars
==============
-Simple documentation with local source
+Sample documentation with local source:
.. code-block:: yaml
@@ -22,7 +26,7 @@
engine: local
path: '/path/to/sphinx/documentation'
-Simple documentation with Git source
+Sample documentation with Git source:
.. code-block:: yaml
@@ -37,7 +41,7 @@
address: 'git@repo1.domain.com/repo.git'
revision: master
-Simple documentation with reclass source
+Sample documentation with Reclass source:
.. code-block:: yaml
@@ -50,6 +54,21 @@
source:
engine: reclass
+Sample documentation with pillar-schema source:
+
+.. code-block:: yaml
+
+ sphinx:
+ server:
+ enabled: true
+ doc:
+ schemas_doc:
+ author: Author
+ year: Year
+ version: Version
+ builder: 'html'
+ source:
+ engine: pillar-schema
Read more
=========