Sergei Trofimov
275c243764
doc: add output API docs
...
- Add a reference tag for metadata
- Remove doc/source/api from .gitignore -- this is no longer
auto-generated.
- Add a top-level "index" for the API documentation.
- Add output API documentation.
- Remove the output API example file, as its contents is now part of the
output API docs.
2018-06-25 17:11:47 +01:00
Marc Bonnici
92df8852fd
doc: Rename references to folder
to directory
to be consistent.
2018-06-11 08:10:07 +01:00
Marc Bonnici
3839da166d
doc: Fix instrument documentation
...
Fixed outdated `update_results` method references.
2018-06-11 08:10:07 +01:00
Waleed El-Geresy
0269a30ca6
docs:writing_plugins: Typos and Grammar
2018-06-08 17:50:22 +01:00
sdpenguin
1a98b8a4d3
Typo fix
2018-06-08 17:12:02 +01:00
Sergei Trofimov
3545c855b8
doc: add note on classifiers vs metadata
...
Add a small section on classifiers to the plugin writing docs, and a
section comparing them with metadata and clarifying when to use one or
the other.
2018-05-25 15:27:14 +01:00
Sergei Trofimov
51955ee0e0
doc: add metadata docs
...
Document the new metadata feature.
2018-05-25 15:27:14 +01:00
Sergei Trofimov
63fe32584b
doc: update metrics and artifacts docs
...
Update documentation for metrics and artifacts documentation to show
how these may be added by a plugin.
2018-05-25 15:27:14 +01:00
Sergei Trofimov
e5e8406e1f
doc: minor fix to resource resolution docs
...
Correct the documentation for what happens if a resource is not found.
2018-05-25 10:21:06 +01:00
Sergei Trofimov
79141582e9
fw/workload: record app version in metadata
...
Add the package version for an ApkWorkload to the metadata for that job.
2018-05-25 10:21:06 +01:00
Marc Bonnici
04fe3768af
doc: Misc fixes
...
Fix typos, formatting and irrelevant information.
2018-05-21 10:26:28 +01:00
Sergei Trofimov
b1b2131b0c
doc: fix build warnings
2018-05-18 10:32:08 +01:00