Creating an initial structure for docs
Change-Id: I6e2a885536dceb2bcc92939d2e7043cbf5a64c61
This commit is contained in:
3
docs/source/architecture/behavior.rst
Normal file
3
docs/source/architecture/behavior.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
==========
|
||||
Behaviors
|
||||
==========
|
||||
3
docs/source/architecture/client.rst
Normal file
3
docs/source/architecture/client.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
========
|
||||
Clients
|
||||
========
|
||||
9
docs/source/architecture/index.rst
Normal file
9
docs/source/architecture/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
======================
|
||||
OpenCAFE Architecture
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
|
||||
model
|
||||
client
|
||||
behavior
|
||||
3
docs/source/architecture/model.rst
Normal file
3
docs/source/architecture/model.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
=======
|
||||
Models
|
||||
=======
|
||||
@@ -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
|
||||
|
||||
9
docs/source/contributing/index.rst
Normal file
9
docs/source/contributing/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
===============
|
||||
Contributing
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
standards
|
||||
process
|
||||
3
docs/source/contributing/process.rst
Normal file
3
docs/source/contributing/process.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
===============
|
||||
Review Process
|
||||
===============
|
||||
3
docs/source/contributing/standards.rst
Normal file
3
docs/source/contributing/standards.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
=================
|
||||
Coding Standards
|
||||
=================
|
||||
3
docs/source/faq/index.rst
Normal file
3
docs/source/faq/index.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
======
|
||||
FAQs
|
||||
======
|
||||
9
docs/source/getting_started/index.rst
Normal file
9
docs/source/getting_started/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
==================
|
||||
Getting Started
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
|
||||
setting_up_env
|
||||
install
|
||||
using
|
||||
4
docs/source/getting_started/install.rst
Normal file
4
docs/source/getting_started/install.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
====================
|
||||
Installing OpenCAFE
|
||||
====================
|
||||
|
||||
3
docs/source/getting_started/setting_up_env.rst
Normal file
3
docs/source/getting_started/setting_up_env.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
====================
|
||||
Setup Environment
|
||||
====================
|
||||
4
docs/source/getting_started/using.rst
Normal file
4
docs/source/getting_started/using.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
====================
|
||||
Using OpenCAFE
|
||||
====================
|
||||
|
||||
@@ -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
|
||||
|
||||
11
docs/source/plugin_dev/index.rst
Normal file
11
docs/source/plugin_dev/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
===================
|
||||
Plugin Development
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
|
||||
writing_your_first
|
||||
|
||||
Overview
|
||||
===========
|
||||
|
||||
3
docs/source/plugin_dev/writing_your_first.rst
Normal file
3
docs/source/plugin_dev/writing_your_first.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
==========================
|
||||
Writing your first plugin
|
||||
==========================
|
||||
Reference in New Issue
Block a user