diff options
| author |   Justin-chi <chigang@huawei.com> | 2016-01-17 16:23:12 +0800 |
|---|---|---|
| committer | Justin-chi <chigang@huawei.com> | 2016-01-21 15:40:17 +0800 |
| commit | 080b1de19bc76a3e4435a73151d180d2267e4e59 (patch) | |
| tree | c10c2ad818dcdd38d30b80e385350b16e59d378b /docs/how-to-use-compass4nfv/documentation-compass4nfv.rst | |
| parent | ebf474f7dd65ed8d098e80959aec777c202ee7be (diff) | |
Document update for Brahmaputra
JIRA: COMPASS-75
add installation instruction
add FAQ.rst(draft) and release-notes(draft)
add some correction
Change-Id: I8fc48c79eeea06bc2efafce2eca72ebd9b71be16
Signed-off-by: Justin-chi <chigang@huawei.com>
Diffstat (limited to 'docs/how-to-use-compass4nfv/documentation-compass4nfv.rst')
| -rw-r--r-- | docs/how-to-use-compass4nfv/documentation-compass4nfv.rst | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst index c9e40dd7..7fbd1578 100644 --- a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst +++ b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst @@ -544,45 +544,3 @@ How to integration plugins - - - - - - -The Sphinx Build -================ - -When you push documentation changes to gerrit a jenkins job will create html documentation. - -* Verify Jobs - -For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result. - -* Merge jobs - -Once you are happy with the look of your documentation you can submit the patchset -the merge job will copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html - -Here are some quick examples of how to use rst markup - -This is a headline:: - - here is some code, note that it is indented - -links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/ - -* Bulleted Items - - **this will be bold** - -.. code-block:: bash - - echo "Heres is a code block with bash syntax highlighting" - - -Leave these at the bottom of each of your documents they are used internally - -Revision: _sha1_ - -Build date: |today| |