Misc Changes

[opnfvdocs.git] / docs / how-to-use-docs / documentation-example.rst

diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 33261ef..16609e0 100644 (file)
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -61,7 +61,7 @@ Source Files
 ============
 
 Document source files have to be written in reStructuredText format (rst).
-Each file would be build as an html page and a chapter in PDF.
+Each file would be build as an html page.
 
 Here is an example source rst file :
 
@@ -81,29 +81,10 @@ Writing RST Markdown
 
 See http://sphinx-doc.org/rest.html .
 
-**Hint:**
-Table and its contents won't be adjusted, so you may need to fix your source
-text when your table is truncated in PDF version. Or, you can use 'longtable'
-option that splits your table vertically (by rows) in multiple pages.
-It is useful if you have trouble in rendering table containing many rows.
-
-.. code-block:: bash
-
-    .. table::
-        :class: longtable
-
-        +------------------------+------------+----------+----------+
-        | Header row, column 1   | Header 2   | Header 3 | Header 4 |
-        +========================+============+==========+==========+
-        | body row 1, column 1   | column 2   | column 3 | column 4 |
-        +------------------------+------------+----------+----------+
-        | body row 2             | ...        | ...      |          |
-        +------------------------+------------+----------+----------+
-
 **Hint:**
 You can add dedicated contents by using 'only' directive with build type
-('html' and 'pdf') for OPNFV document. But, this is not encouraged to use
-since this may make different views in HTML and PDF version.
+('html' and 'singlehtml') for OPNFV document. But, this is not encouraged to
+use since this may make different views.
 
 .. code-block:: bash
 
@@ -126,36 +107,24 @@ added if they are not set in the ``conf.py``.
   'sphinx.ext.viewcode',
   'sphinx.ext.napoleon']
 * **needs_sphinx** = '1.3'
+* **numfig** = True
 * **master_doc** = 'index'
 * **pygments_style** = 'sphinx'
 * **html_use_index** = False
-* **numfig** = True
 * **html_logo** = 'opnfv-logo.png'
-* **latex_domain_indices** = False
-* **latex_logo** = 'opnfv-logo.png'
-* **latex_documents** =
-  [('index', '``document directory name``.tex',
-  '``document title in index.rst``', 'OPNFV', 'manual'),]
+* **html_sidebars** = {'**': ['globaltoc.html',
+  '``path to opnfvdocs dir``/etc/pagemenu.html',
+  'searchbox.html']}
 * **release** = '``git last tag name`` (``git last commit hash``)'
 * **version** = '``git last tag name`` (``git last commit hash``)'
 * **project** = '``git repo name``'
 * **copyright** = '``year``, OPNFV'
-
-See http://sphinx-doc.org/config.html to learn sphinx configuration.
+* **rst_epilog** = '    Revision:``git last commit hash``\n    Build date:``build date in year-month-date format``'
 
 **Note:**
 You can leave the file path for OPNFV logo image which will be prepared
 before each document build.
 
-**Hint:**
-In PDF, figures will be floated to get better view. If you want to avoid such
-automated fixes, just add this option to your conf.py after copying the default
-configuration in to the document directory.
-
-.. code-block:: bash
-
-    latex_elements = {'figure_align': 'H'}
-
 Versioning
 ==========
 
@@ -171,6 +140,7 @@ also used in document build jobs below:
 
 .. code-block:: bash
 
+    $ sudo pip install virtualenv
     $ cd /local/repo/path/to/project
     $ git clone https://git.opnfv.org/opnfvdocs docs_build/_opnfvdocs
     $ ./docs_build/_opnfvdocs/scripts/docs-build.sh
@@ -212,8 +182,8 @@ Verify Job
 The verify job name is **opnfv-docs-verify**.
 
 When you send document changes to gerrit, jenkins will create your documents
-in HTML and PDF formats to verify that new document can be built successfully.
-Please check the jenkins log and artifact carefully.
+in HTML formats (normal and single-page) to verify that new document can be
+built successfully. Please check the jenkins log and artifact carefully.
 You can improve your document even though if the build job succeeded.
 
 Documents will be uploaded to
@@ -223,11 +193,6 @@ patch set to gerrit, and deleted after the change is merged.
 Document link(s) can be found in your change page on gerrit as a review
 comment.
 
-Note:
-Currently, the job reports 'SUCCESS' as result of document build even if the
-PDF creation failed. This is a provisional workaround, since many projects are
-not ready for PDF creation yet.
-
 Merge Job
 ----------
 
@@ -256,3 +221,11 @@ document build.
 
 .. _opnfvdocs/scripts/docs-build.sh:
     https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob;f=scripts/docs-build.sh;
+
+Hooks
+=====
+
+The document builder script supports pre-hook. If you need to execute some
+commands before starting to build process (e.g. generate API rst from codes),
+create '<your repo>/docs/pre-hook.sh' which will be executed (using 'source')
+once before all document build start.