openstack/os-ken
Code Issues Proposed changes
Files
d74ca437b4c190094318a7c2bf337f3f5d0dd80b
os-ken/doc/source
History
Akihiro Motoki d74ca437b4 doc: Improve the document structure 
This commit updates the document structure to fix
both HTML and PDF versions.
Some minor fixes are also included.

* doc/source/conf.py: Specify openany and oneside
  as extra class options for LaTeX.
* doc/source/conf.py: Specify the depth of TOC for PDF.
* Create a separate top page for "Archived Contents"
* Adjust the content of doc/source/contributor/index.rst
  to avoid unnecessary subsection.
* Drop strings from the top page as they leads to
  separate pages in the PDF file.
* Add "T.B.D." comments to placeholder documents.
* CONTRIBUTING.rst: Remove unnecessary markups for quoting texts.
* doc/source/parameters.rst: Update the mailing list link.

Story: 2006099
Task: 35137
Change-Id: I5fc03cd8ba53df58ee75e1c1bac4e906f840ec4e
2019-10-01 17:18:14 +09:00
..
_static
initial commit
2011-12-09 15:56:05 +09:00
_templates
initial commit
2011-12-09 15:56:05 +09:00
admin
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
app
Fixup the docs building
2018-10-17 18:51:14 +00:00
configuration
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
contributor
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
library
Apply OpenStack Cookiecutter template
2018-09-04 17:00:24 +00:00
library_packet_ref
Fixup the docs building
2018-10-17 18:51:14 +00:00
man
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
quantumclient
doc: add components page
2014-05-27 20:24:50 +09:00
reference
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
user
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
api_ref.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
app.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
archive.rst
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
components.rst
Add CLI scripts from osken to be installed via setup.cfg
2018-12-12 15:04:37 +01:00
conf.py
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
configuration.rst
document: ryu.app.gui_topology
2014-06-23 17:12:51 +09:00
developing.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
docutils.conf
doc: Deprecated option html_use_smartypants
2017-07-30 22:07:06 +09:00
gui.png
document: ryu.app.gui_topology
2014-06-23 17:12:51 +09:00
gui.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
index.rst
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
library_bgp_speaker_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_bgp_speaker.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_mrt.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
library_of_config.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_ovsdb_manager.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
library_ovsdb.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_packet_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_packet.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
library_pcap.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
library.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
nicira_ext_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_base.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_ref.rst
doc: Add openflow api reference for of1.0
2015-10-11 21:51:38 +09:00
ofproto_v1_0_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_v1_2_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_v1_3_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_v1_4_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
ofproto_v1_5_ref.rst
Fixup the docs building
2018-10-17 18:51:14 +00:00
os_ken_app_api.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
parameters.rst
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
readme.rst
doc: Improve the document structure
2019-10-01 17:18:14 +09:00
snort_integrate.rst
Add CLI scripts from osken to be installed via setup.cfg
2018-12-12 15:04:37 +01:00
test-of-config-with-linc.rst
Add CLI scripts from osken to be installed via setup.cfg
2018-12-12 15:04:37 +01:00
test-vrrp.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
tests.rst
doc: add test-of-config-with-linc page
2014-06-03 22:51:56 +09:00
tls.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00
writing_os_ken_app.rst
Rename "ryu" to "os_ken" everywhere
2018-11-27 20:48:02 +00:00

readme.rst

Overview

A component-based software defined networking framework in OpenStack.

os-ken is a fork of the Ryu library tailored for OpenStack Neutron.

View Git Blame Copy Permalink