diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-11-23 15:28:23 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@172.30.200.206> | 2015-11-23 15:28:23 +0000 |
| commit | 082a030caad50441ba646689ccc0af3912e6c320 (patch) | |
| tree | e6a990264165c444a9f07186b23f428af45a940f | |
| parent | 7f549d3fdcbea979deee8fc0808043a18567f298 (diff) | |
| parent | 351238c6fe772886f8f62f74e9aa9237f0f1067e (diff) | |
Merge "doc: fix logo setting for sphinx-build"
| -rw-r--r-- | docs/etc/conf.py | 2 | ||||
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 10 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/jenkins-job-builder/index.rst | 9 | ||||
| -rw-r--r-- | docs/jenkins-job-builder/opnfv-jjb-usage.rst | 11 |
5 files changed, 4 insertions, 34 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py index 671965378..68e847ee9 100644 --- a/docs/etc/conf.py +++ b/docs/etc/conf.py @@ -10,6 +10,7 @@ source_suffix = '.rst' 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" @@ -20,6 +21,7 @@ pdf_stylesheets = ['sphinx','kerning','a4'] latex_elements = { 'printindex': '', } +latex_logo = 'opnfv-logo.png' project = u'Copper: Virtual Infrastructure Deployment Policies' copyright = u'%s, OPNFV' % datetime.date.today().year diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf75814..764b546c8 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,12 +1,5 @@ .. 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 ================================================== @@ -55,6 +48,7 @@ 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 diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst index 36710b32d..2d493318d 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -3,12 +3,6 @@ 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 ======================================= diff --git a/docs/jenkins-job-builder/index.rst b/docs/jenkins-job-builder/index.rst index 1ea4a95a5..05847a1e0 100644 --- a/docs/jenkins-job-builder/index.rst +++ b/docs/jenkins-job-builder/index.rst @@ -3,15 +3,6 @@ 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 =========================== diff --git a/docs/jenkins-job-builder/opnfv-jjb-usage.rst b/docs/jenkins-job-builder/opnfv-jjb-usage.rst index 8e4a1a831..1945490f5 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 ============================================ @@ -184,8 +175,6 @@ The Current merge and verify jobs for jenkins job builder as pulled from the rep cd /opt/jenkins-ci/releng git pull jenkins-jobs update --delete-old jjb/ - - Revision: _sha1_ |