diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/etc/conf.py | 32 | ||||
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 30 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 25 | ||||
| -rw-r--r-- | docs/jenkins-job-builder/index.rst | 22 | ||||
| -rw-r--r-- | docs/jenkins-job-builder/opnfv-jjb-usage.rst | 56 |
5 files changed, 51 insertions, 114 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py index 671965378..f42b11055 100644 --- a/docs/etc/conf.py +++ b/docs/etc/conf.py @@ -1,27 +1,27 @@ -import datetime -import sys -import os +''' +Base configuration file for sphinx-build. -needs_sphinx = '1.3' +You can override this configuration by putting 'conf.py' in the document +directory (e.g. how-to-use-docs/conf.py). If there is no 'conf.py' in the +document directory, this file will be copied to that directory before the +document builder jobs in 'opnfv-docs-verify' and 'opnfv-docs-merge'. +The logo image (opnfv-logo.png) will be also copied from +docs/etc/opnfv-logo.png during the build jobs. +''' -numfig = True +import datetime -source_suffix = '.rst' +needs_sphinx = '1.3' master_doc = 'index' pygments_style = 'sphinx' -html_use_index = False -pdf_documents = [('index', u'Copper', u'Copper Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False +html_use_index = False +numfig = True +html_logo = 'opnfv-logo.png' -latex_elements = { - 'printindex': '', -} +latex_elements = {'printindex': ''} +latex_logo = 'opnfv-logo.png' -project = u'Copper: Virtual Infrastructure Deployment Policies' copyright = u'%s, OPNFV' % datetime.date.today().year version = u'1.0.0' release = u'1.0.0' diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf75814..e18ce598b 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,12 +1,3 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -.. these two pipes are to seperate the logo from the first title -| -| How to create documentation for your OPNFV project ================================================== @@ -28,8 +19,9 @@ This index file must refence your other rst files. .. code-block:: bash - Example Documentation table of contents - ======================================= + ===================== + Example Documentation + ===================== Contents: @@ -39,10 +31,8 @@ This index file must refence your other rst files. documentation-example.rst - Indices and tables - ================== - - * :ref:`search` + .. + Leave these at the bottom of 'index.rst' file Revision: _sha1_ @@ -55,11 +45,12 @@ 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 +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 @@ -77,10 +68,3 @@ links are easy to add: Here is a link to sphinx, the tool that we are using to g .. 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| diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst index 36710b32d..0965eb3cd 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -1,18 +1,9 @@ -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. + This is new template created on Thu Nov 26 16:18:09 JST 2015 -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -Example Documentation table of contents -======================================= - -Contents: +===================== +Example Documentation +===================== .. toctree:: :numbered: @@ -20,10 +11,8 @@ Contents: documentation-example.rst -Indices and tables -================== - -* :ref:`search` +.. + Leave these at the bottom of 'index.rst' file Revision: _sha1_ diff --git a/docs/jenkins-job-builder/index.rst b/docs/jenkins-job-builder/index.rst index 1ea4a95a5..f8f568339 100644 --- a/docs/jenkins-job-builder/index.rst +++ b/docs/jenkins-job-builder/index.rst @@ -1,33 +1,13 @@ -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -| -| - +=========================== Release Engineering Project =========================== -Contents: - .. toctree:: :numbered: :maxdepth: 8 opnfv-jjb-usage.rst -Indices and tables -================== - -* :ref:`search` - Revision: _sha1_ Build date: |today| diff --git a/docs/jenkins-job-builder/opnfv-jjb-usage.rst b/docs/jenkins-job-builder/opnfv-jjb-usage.rst index 8e4a1a831..4aecc6de6 100644 --- a/docs/jenkins-job-builder/opnfv-jjb-usage.rst +++ b/docs/jenkins-job-builder/opnfv-jjb-usage.rst @@ -1,12 +1,3 @@ -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -| -| - Creating/Configuring/Verifying Jenkins Jobs ============================================ @@ -69,22 +60,22 @@ The Current merge and verify jobs for jenkins job builder as pulled from the rep jobs: - 'builder-verify-jjb' - 'builder-merge' - + project: 'releng' - + - job-template: name: builder-verify-jjb - + node: master - + project-type: freestyle - + logrotate: daysToKeep: 30 numToKeep: 10 artifactDaysToKeep: -1 artifactNumToKeep: -1 - + parameters: - project-parameter: project: '{project}' @@ -95,11 +86,11 @@ The Current merge and verify jobs for jenkins job builder as pulled from the rep credentials-id: '{ssh-credentials}' refspec: '$GERRIT_REFSPEC' choosing-strategy: 'gerrit' - + wrappers: - ssh-agent-credentials: user: '{ssh-credentials}' - + triggers: - gerrit: trigger-on: @@ -123,45 +114,45 @@ The Current merge and verify jobs for jenkins job builder as pulled from the rep pattern: jjb/** - compare-type: ANT pattern: jjb-templates/** - - + + builders: - shell: !include-raw verify-releng - + - job-template: name: 'builder-merge' - + node: master - + # builder-merge job to run JJB update # # This job's purpose is to update all the JJB - + project-type: freestyle - + logrotate: daysToKeep: 30 numToKeep: 40 artifactDaysToKeep: -1 artifactNumToKeep: 5 - + parameters: - project-parameter: project: '{project}' - gerrit-parameter: branch: 'master' - + scm: - gerrit-trigger-scm: credentials-id: '{ssh-credentials}' refspec: '' choosing-strategy: 'default' - + wrappers: - ssh-agent-credentials: user: '{ssh-credentials}' - + triggers: - gerrit: trigger-on: @@ -177,17 +168,10 @@ The Current merge and verify jobs for jenkins job builder as pulled from the rep file-paths: - compare-type: ANT pattern: jjb/** - + builders: - shell: | source /opt/virtualenv/jenkins-job-builder/bin/activate cd /opt/jenkins-ci/releng git pull jenkins-jobs update --delete-old jjb/ - - - - -Revision: _sha1_ - -Build date: |today| |