Waleed El-Geresy
6239f6ab2f
Update documentation
...
Update documentation with new API for Output Processors which includes
the context in the intialize and finalize methods.
2018-09-05 14:40:42 +01:00
Waleed El-Geresy
1c48589860
doc: Rename execution_model to framework_overview
...
An update to more aptly suit the new general title of the section.
2018-07-05 11:34:19 +01:00
Waleed El-Geresy
a3b02872ac
Docs: Run Output - Clarification and Additions
...
Clarification of the meanings of and the distinction between the
output-related terms iteration, job, workload and section for those
unfamiliar
- Add entries to the glossary and references to the glossary
- Added section on Configuration parameter hierarchy
- Added section on the number and names of directories generated for
jobs in the run output folder
2018-07-05 11:34:19 +01:00
Marc Bonnici
60989ef66c
doc/contributing: Add a guide to documentation styles
...
Add a documentation style guide to aid in keeping a consistent style
when adding new documentation.
2018-06-29 11:04:09 +01:00
Marc Bonnici
c67994260d
doc: Update heading underlines
...
Ensure consistency for title levels throughout documentation.
2018-06-29 11:04:09 +01:00
Sergei Trofimov
ef16d7a754
doc: add output processing how-to
...
Add a developer how-to illustrating the use of WA output processing API
by creating an ASCII reporter.
2018-06-28 12:10:19 +01:00
Marc Bonnici
116c260bae
doc: Reorganise Developer Guide/Reference
2018-06-26 16:25:05 +01:00
Marc Bonnici
e66ae050a9
doc/dev_how_tos: Remove 'Example' from headings and update tags
2018-06-26 16:25:05 +01:00
Marc Bonnici
ca17542d56
doc: Fix old references to results processors
2018-06-26 16:25:05 +01:00
Marc Bonnici
3c467dce95
doc: Fix missing import in Getter example
2018-06-26 16:25:05 +01:00
Marc Bonnici
3ed14e9864
doc: Fix instrument update_output method description
2018-06-26 16:25:05 +01:00
Marc Bonnici
af8bc42cc2
doc: Update resolver example to use context directly
2018-06-26 16:25:05 +01:00
Marc Bonnici
37d6433214
doc: Improve Adding a Workload how to
2018-06-26 16:25:05 +01:00
Marc Bonnici
23eb428829
doc: Add additional references and formatting
2018-06-26 16:25:05 +01:00
Marc Bonnici
2f94d12b57
doc: Restructure developer information
...
Re-organise and add additional information to developer guide.
2018-06-26 16:25:05 +01:00
Marc Bonnici
750e206b85
doc/dev_reference: Update to use correct API formatting
...
Update the interfaces for Workloads OutputProcessors and Instruments to be
formatted as an API correctly.
2018-06-26 16:25:05 +01:00
Marc Bonnici
9d160b1381
doc/execution_model: Remove unintentional heading
2018-06-26 16:25:05 +01:00
Marc Bonnici
d637557f5a
doc: Update links to have more useful display text
2018-06-26 16:25:05 +01:00
Marc Bonnici
716af1b966
doc: Make config listsing a consistent style
2018-06-26 16:25:05 +01:00
Marc Bonnici
6c93590062
doc: Restructure
...
Restructure the documentation to be split into `User Information` and
`Developer Information`, and split the how to guides into their
corresponding section.
2018-06-26 16:25:05 +01:00
