From 6686b5bfe483b6a518a984b594bb18f9b4239683 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Wed, 25 Nov 2015 22:23:01 +0900 Subject: doc: fix rst and jjb to have consistent view in html and pdf JIRA: RELENG-16 Change-Id: I6e36f16be6e1c9160820d137a78ac1e7674153f0 Signed-off-by: Ryota MIBU --- docs/etc/conf.py | 30 +++++++++++--------------- docs/how-to-use-docs/documentation-example.rst | 20 +++++------------ docs/how-to-use-docs/index.rst | 19 ++++++---------- docs/jenkins-job-builder/index.rst | 13 +---------- docs/jenkins-job-builder/opnfv-jjb-usage.rst | 5 ----- 5 files changed, 25 insertions(+), 62 deletions(-) (limited to 'docs') diff --git a/docs/etc/conf.py b/docs/etc/conf.py index 68e847ee9..6245cc069 100644 --- a/docs/etc/conf.py +++ b/docs/etc/conf.py @@ -1,29 +1,23 @@ -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). +''' -numfig = True +import datetime -source_suffix = '.rst' +needs_sphinx = '1.3' 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" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False +html_use_index = False +numfig = True +html_logo = '../etc/opnfv-logo.png' -latex_elements = { - 'printindex': '', -} -latex_logo = 'opnfv-logo.png' +latex_elements = {'printindex': ''} +latex_logo = '../etc/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 764b546c8..fd0563fda 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,5 +1,3 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - How to create documentation for your OPNFV project ================================================== @@ -21,8 +19,9 @@ This index file must refence your other rst files. .. code-block:: bash - Example Documentation table of contents - ======================================= + ===================== + Example Documentation + ===================== Contents: @@ -32,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_ @@ -71,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 2d493318d..0965eb3cd 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -1,12 +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 -Example Documentation table of contents -======================================= - -Contents: +===================== +Example Documentation +===================== .. toctree:: :numbered: @@ -14,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 05847a1e0..f8f568339 100644 --- a/docs/jenkins-job-builder/index.rst +++ b/docs/jenkins-job-builder/index.rst @@ -1,24 +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. - +=========================== 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 1945490f5..fa825c430 100644 --- a/docs/jenkins-job-builder/opnfv-jjb-usage.rst +++ b/docs/jenkins-job-builder/opnfv-jjb-usage.rst @@ -175,8 +175,3 @@ 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_ - -Build date: |today| -- cgit 1.2.3-korg