diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-11-06 15:30:41 -0800 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-11-12 16:19:00 +0000 |
| commit | b7be4af0b9859b773613af48dac0a8a99b35edf2 (patch) | |
| tree | 0e94542de775c3228c9efd6da9cca08ee96ed22f /docs/how-to-use-docs/include-documentation.rst | |
| parent | 5685c25e012d77ca4395ecd7db2a9d7781246908 (diff) | |
Fix minor Documentation Formatting Errors
These include wrongly indented bullet points, title underlines, and
malfomed links. Templates which are used for project documentation are
also excluded from builds as they are orphaned pages.
Change-Id: Iaabfb5f2bbf0b9bdfabec622e0b75dd23ea9e472
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
(cherry picked from commit e096c7fb3fd1c43dbf6588ced287ece1db7d1350)
Diffstat (limited to 'docs/how-to-use-docs/include-documentation.rst')
| -rw-r--r-- | docs/how-to-use-docs/include-documentation.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst index d1a5a6227..1798469dc 100644 --- a/docs/how-to-use-docs/include-documentation.rst +++ b/docs/how-to-use-docs/include-documentation.rst @@ -1,4 +1,5 @@ .. _include-documentation: + ============================ Including your Documentation ============================ @@ -229,7 +230,7 @@ specified output folder directory. Adding your project repository as a submodule --------------------------- +--------------------------------------------- Clone the opnfvdocs repository and your submodule to .gitmodules following the convention of the file @@ -244,7 +245,10 @@ Clone the opnfvdocs repository and your submodule to .gitmodules following the c git review Removing a project repository as a submodule --------------------------- +-------------------------------------------- + +.. code-block:: bash + git rm docs/submodules/$reponame rm -rf .git/modules/$reponame git config -f .git/config --remove-section submodule.$reponame 2> /dev/null |