diff options
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
4 files changed, 7 insertions, 14 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index eccd0022a..2d8a25cfa 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the This line will be shown only in html version. -.. index:: single: indices - Creating Indices ---------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 8fd9a730b..9c5822d2b 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is integrated for each release. Other ONAP projects will provide content that is referenced from this structure. -.. index:: master :: @@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by RST file changes in the top level docs directory and below. -.. index:: licensing Licensing --------- diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 4a7300d16..15d71d453 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -390,23 +390,15 @@ Download the DOC repository. git clone http://gerrit.onap.org/r/doc -Change directory to docs & install requirements. - -.. code-block:: bash - - cd doc - sudo pip install -r etc/requirements.txt - Update submodules, build documentation using tox & then open using any browser. .. code-block:: bash cd doc - git submodule update --depth 1 --init - tox -edocs + tox -elocal firefox docs/_build/html/index.html -.. note:: Make sure to run `tox -edocs` and not just `tox`. +.. note:: Make sure to run `tox -elocal` and not just `tox`. diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index a73ae6fb3..6f1dd2d33 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,3 +12,8 @@ Creating Documentation include-documentation converting-formats addendum + +.. toctree:: + :hidden: + + update-review.rst |