michaelh/zephyr
1
0
Fork 0
Code Releases Activity

ADD framework files for ReST content.

Browse source 
Includes the documentation license, a
substitutions file and a README detailing the new infrastructure and its
installation.

Updates the master file, index.rst, to accomodate the content files.

Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-05-15 11:38:34 -05:00 • committed by Anas Nashif
commit a4a50fa2d9
4 changed files with 104 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

76
doc/README.rst Normal file
View file

@ -0,0 +1,76 @@
.. include:: substitutions.rst
Welcome to |codename|
#####################
.. This document is in Restructured Text Format.
More information at `<http://sphinx-doc.org/rest.html>`_.
This is a comment that won't show up in formatted output
Welcome to |project|.
Thank you for your interest in |project|. Read the instructions
carefully to generate the |project|'s documentation.
Documentation Notes
*******************
The documentation of |project| currently comprises the following items:
* An Installation Guide for Linux host systems
* A set of Collaboration Guidelines for the |project| project.
* Raw Doxygen output from the code base.
Installing the documentation processors
***************************************
Install the current version of :program:`Sphinx`, type:
.. code-block:: bash
$ git clone:: $ export http_proxy=http://PROXY:PORT $ export
https_proxy=http://PROXY:PORT
$ git clone https://github.com/sphinx-doc/sphinx.git sphinx
$ cd sphinx
$ sudo -E python setup.py install
$ git clone https://github.com/michaeljones/breathe.git breathe
$ cd breathe
$ sudo -E python setup.py install
.. note::
Make sure that :program:`Doxygen` is installed in your system.
The installation of Doxygen is beyond the scope of this document.
Running the documentation generators
************************************
Assuming that the |project| tree with the doc patches is in
:file:`DIRECTORY`, type:
.. code-block:: bash
$ cd DIRECTORY/doc
$ make doxy html
Find the output in :file:`DIRECTORY/doc/_build/html/index.html`
Review the available formats with:
.. code-block:: bash
$ make -C DIRECTORY/doc doxy html
If you want the LaTeX PDF output, you need to install all the Latex
packages first. That installation is beyond the scope of this document.

11
doc/documentation_license.rst Normal file
View file

@ -0,0 +1,11 @@
Copyright © 2015 Intel Corporation
.. raw:: html
<embed> <a rel="license"
href="http://creativecommons.org/licenses/by/4.0/"><img
alt="Creative Commons License" style="border-width:0"
src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br
/>This work is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
Attribution 4.0 International License</a></embed>

18
doc/index.rst
View file

@ -1,15 +1,21 @@
.. Tiny Mountain documentation master file, created by
sphinx-quickstart on Tue May 5 22:43:00 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
..
Tiny Mountain's documentation master file
.. include:: documentation_license.rst
.. toctree::
:maxdepth: 2
installation/installation.rst
collaboration/collaboration.rst
doxygen/doxygen.rst
Indices and tables
==================
##################
* :ref:`genindex`
* :ref:`search`
* :ref:`search`

5
doc/substitutions.rst Normal file
View file

@ -0,0 +1,5 @@
.. |codename| replace:: Tiny Mountain
.. |PM| replace:: Hirally Rodriguez Santiago
.. |project| replace:: Tiny Mountain