diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-07-20 19:30:05 +0900 |
|---|---|---|
| committer | Ryota Mibu <r-mibu@cq.jp.nec.com> | 2016-07-22 11:50:47 +0000 |
| commit | a3174cb38b1dc22802da837d1bd0c3e117b9f43a (patch) | |
| tree | 78073ef4812f3e3a4add81beecb29cf1d6dfe441 /docs/how-to-use-docs | |
| parent | 2b890ae86bc8dcc16cc7e1f0cb00357c7892486b (diff) | |
improve config
A developer was asked to copy all contents in the base config file in
order to set all parameters properly, even if the change is partial.
This patch improves this config by setting all default parameters based
on users' custom config file, so that they can write parameters just
which they want to change.
Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'docs/how-to-use-docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index 33261eff4..85133ad83 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -126,10 +126,10 @@ 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' @@ -140,8 +140,7 @@ added if they are not set in the ``conf.py``. * **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 |