Commit Graph

11 Commits

Author SHA1 Message Date
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
Hongbin Lu af2e4fcee4 Apply OpenStack Cookiecutter template
Change-Id: I7172220a2b40cb856080e958bd4a340975449181
2018-09-04 17:00:24 +00:00
IWASE Yusuke 83650576e4 travis: Introduce autopep8 test
This patch add a new test using "autopep8" to keep codes reformatted
easily by using Python tool.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-12-17 19:27:46 +09:00
IWASE Yusuke bdf3549563 pycodestyle: Replace pep8
pep8 has been renamed to pycodestyle and will be removed in a future
release.

This patch replaces pep8 by pycodestyle and adding some settings for
pycodestyle.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-12-17 19:27:41 +09:00
FUJITA Tomonori a991fed7e4 Revert "tests: Separate test files from Ryu module"
This reverts commit a67ed28584.

The commit breaks OpenStack neutron dynamic routing.
2017-06-30 14:23:03 +09:00
IWASE Yusuke a67ed28584 tests: Separate test files from Ryu module
To prevent redundant files (e.g., pcap files, json files for tests,
packet data generator) to be installed, this patch separates test
directory from Ryu module.

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-26 15:17:44 +09:00
IWASE Yusuke 0f1430edfd CONTRIBUTING: Update info of Python ver/lib and links
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-22 16:07:57 +09:00
IWASE Yusuke b4786a3fe3 CONTRIBUTING: Update procedure for running tests
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-22 16:07:54 +09:00
IWASE Yusuke ef212fe87e CONTRIBUTING: Update procedure for submitting patches
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-06-22 16:07:49 +09:00
FUJITA Tomonori 2651909844 doc: update obsolete Linux kernel SubmittingPatches url
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-08-29 22:39:33 +09:00
FUJITA Tomonori a1fe3d92db Rename to CONTRIBUTING.rst
This makes the GitHub interface aware of the contribution guidelines,
so it will be displayed to contributors when they submit issues or
pull requests.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-16 15:56:59 +09:00