master_doc = 'index'
pygments_style = 'sphinx'
html_use_index = False
+html_logo = 'opnfv-logo.png'
pdf_documents = [('index', u'Copper', u'Copper Project', u'OPNFV')]
pdf_fit_mode = "shrink"
latex_elements = {
'printindex': '',
}
+latex_logo = 'opnfv-logo.png'
project = u'Copper: Virtual Infrastructure Deployment Policies'
copyright = u'%s, OPNFV' % datetime.date.today().year
.. 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
==================================================
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
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
-
Example Documentation table of contents
=======================================
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
===========================
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-
-|
-|
-
Creating/Configuring/Verifying Jenkins Jobs
============================================
cd /opt/jenkins-ci/releng
git pull
jenkins-jobs update --delete-old jjb/
-
-
Revision: _sha1_