Creating an initial structure for docs

Change-Id: I6e2a885536dceb2bcc92939d2e7043cbf5a64c61
This commit is contained in:
John Vrbanac
2014-01-20 19:25:18 -06:00
parent a25bfe15fc
commit feb43424cd
16 changed files with 79 additions and 9 deletions

View File

@@ -0,0 +1,3 @@
==========
Behaviors
==========

View File

@@ -0,0 +1,3 @@
========
Clients
========

View File

@@ -0,0 +1,9 @@
======================
OpenCAFE Architecture
======================
.. toctree::
model
client
behavior

View File

@@ -0,0 +1,3 @@
=======
Models
=======

View File

@@ -36,8 +36,9 @@ pygments_style = 'friendly'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
theme_path = sphinx_rtd_theme.get_html_theme_path()
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_path = [theme_path]
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True

View File

@@ -0,0 +1,9 @@
===============
Contributing
===============
.. toctree::
:maxdepth: 1
standards
process

View File

@@ -0,0 +1,3 @@
===============
Review Process
===============

View File

@@ -0,0 +1,3 @@
=================
Coding Standards
=================

View File

@@ -0,0 +1,3 @@
======
FAQs
======

View File

@@ -0,0 +1,9 @@
==================
Getting Started
==================
.. toctree::
setting_up_env
install
using

View File

@@ -0,0 +1,4 @@
====================
Installing OpenCAFE
====================

View File

@@ -0,0 +1,3 @@
====================
Setup Environment
====================

View File

@@ -0,0 +1,4 @@
====================
Using OpenCAFE
====================

View File

@@ -1,16 +1,15 @@
.. OpenCAFE documentation master file, created by
sphinx-quickstart on Fri Dec 13 14:15:09 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
====================================
Welcome to OpenCAFE's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 2
:maxdepth: 3
getting_started/index
contributing/index
architecture/index
plugin_dev/index
faq/index
Indices and tables

View File

@@ -0,0 +1,11 @@
===================
Plugin Development
===================
.. toctree::
writing_your_first
Overview
===========

View File

@@ -0,0 +1,3 @@
==========================
Writing your first plugin
==========================