diff options
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 36 |
1 files changed, 26 insertions, 10 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index bab2ee157..c0ffc956a 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -27,6 +27,18 @@ Note: You may have "docs/how-to-use-docs/" in you project repo. You can delete it, since it is sample and master version is stored in releng repo. +Note: +During the document build process, 'docs_build' and 'docs_output' will be +created in the project root directory. To avoid conflict, you should not +use those names and should add the following entries in '.gitignore' file +so that git can ignore built files. + +.. code-block:: bash + + /docs_build/ + /docs_output/ + /releng/ + Index File ========== @@ -118,25 +130,29 @@ Testing ======= You can test document build in your laptop by using build script which is -used in document build jobs: +also used in document build jobs below: .. code-block:: bash - $ cd /loacal/repo/path/to/project - $ git clone ssh://gerrit.opnfv.org:29418/releng + $ cd /local/repo/path/to/project + $ git clone https://git.opnfv.org/releng $ ./releng/utils/docs-build.sh -Then, you can see docs in output directory if build succeeded. +Then, you can see the docs in 'docs_output' directory if build succeeded. -This script will generate files in 'build' and 'output'. You should consider -to add the following entries in '.gitignore' file, so that git can ignore -built files. +If you have a problem of missing python package, you can make sure all +necessary packages are installed as follows: .. code-block:: bash - /docs_build/ - /docs_output/ - /releng/ + $ sudo pip install Sphinx==1.3.1 doc8 sphinxcontrib-httpdomain + +Note: +Developers are encouraged to use "ssh://<username>@gerrit.opnfv.org:29418/releng" +instead of "https://git.opnfv.org/releng", so that you can quickly start +development in releng. +See https://wiki.opnfv.org/developer/getting_started for more detail. + Jenkins Jobs ============ |