Commit 286bb107 authored by Benoit Orihuela's avatar Benoit Orihuela
Browse files

Merge branch 'doc/add-troubleshot-documentation' into 'develop' 

doc: bootstrap a doc to help in troubleshooting documentation generation

See merge request !160
parents b399830e f98f3331

README.md

+7 −0
Original line number Diff line number Diff line
@@ -12,11 +12,14 @@ specification of the ETSI NGSI-LD API. 
-   [Install the Test Suite](#install-the-test-suite)

-   [Configure the test suite](#configure-the-test-suite)

-   [Execute the NGSI-LD Test Suite](#execute-the-ngsi-ld-test-suite)

-   [Use the Test Suite Management (tsm) tool](#test-suite-management-tsm)

-   [Contribute to the Test Suite](#contribute-to-the-test-suite)

    -   [Install IDE (PyCharm)](#install-ide-pycharm)

    -   [Develop a new Test Case](#develop-a-new-test-case)

    -   [Run configurations (PyCharm)](#run-configurations-pycharm)

    -   [Pre commit](#pre-commit)

-   [Tooling](#tooling)

-   [Coding style](#coding-style-of-test-suites)

-   [Frameworks and libraries used in the project](#frameworks-and-libraries-used-in-the-project)

-   [Useful links](#useful-links)   

-   [LICENSE](#license)
@@ -376,6 +379,10 @@ Finally, check that everything is OK by running the unit tests: 
python -m unittest discover -s ./doc/tests -t ./doc

```



In order to help in investigating errors that can be encountered when generating the documentation, you can check in

the [Documentation generation troubleshoot document](Troubleshoot_Documentation_Generation.md) for further documentation

and tips.



### Run configurations (PyCharm)



Two sample configurations have been created:

Troubleshoot_Documentation_Generation.md

0 → 100644
+7 −0
Original line number Diff line number Diff line 
# Troubleshoot the generation of the documentation



## Missing setup step description



If a Test Case is built around permutations, you have to use the `Test Setup` (and `Test Teardown`) keywords in order

to properly generate the documentation. If you use `Suite Setup` (and `Suite Teardown`), the generated documentation

will not contain the full description of the setup step (it will not full but it will only contain the generic sentence).