diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-11-25 22:23:01 +0900 |
|---|---|---|
| committer | Ryota Mibu <r-mibu@cq.jp.nec.com> | 2015-11-26 10:23:47 +0000 |
| commit | 6686b5bfe483b6a518a984b594bb18f9b4239683 (patch) | |
| tree | 8880cb319eff4022c1e8b37ac12243fbbd1323ef /docs/how-to-use-docs | |
| parent | 4cb2f7999b7d6bb42443cf32b514f18fc7b579cf (diff) | |
doc: fix rst and jjb to have consistent view in html and pdf
JIRA: RELENG-16
Change-Id: I6e36f16be6e1c9160820d137a78ac1e7674153f0
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 | 20 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 19 |
2 files changed, 12 insertions, 27 deletions
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_ |