138 Commits

Author	SHA1	Message	Date
Marc Bonnici	17bb0083e5	doc/installation: Update installation instructions ... Update the instructions for installing WA from git not to use pip as this method does not process dependency_links correctly and results in an incompatible version of devlib being installed.	2018-10-25 10:32:28 +01:00
Marc Bonnici	c4ad7467e0	doc: Fix formatting and typo	2018-10-25 10:32:28 +01:00
Marc Bonnici	2f75261567	doc: Add WA icon to documentation	2018-10-25 10:32:28 +01:00
Marc Bonnici	891ef60f4d	configuration: Add support for section groups ... Now allows for specifying a `group` value for each section which will cross product the sections within that group with the sections in each other group. Additionally classifiers will automatically be added to each job spec with the relevant group information.	2018-09-24 10:17:26 +01:00
Marc Bonnici	f5fed26758	doc/device_setup: Fix typo	2018-09-21 15:06:30 +01:00
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
Sergei Trofimov	7d833ec112	fw/config: add includes ... Add the ability to include other YAML files inside agendas and config files using "include#:" entries.	2018-07-23 16:47:10 +01:00
Marc Bonnici	915c363fd9	wa: 3.0.0 Release preparation ... - Update 'setup.py' package name to 'wlauto' as 'wa' is already taken on PyPi and update documentation accordingly. - Update old references to Python 2.7	2018-07-06 17:39:26 +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
Marc Bonnici	98bd3e09b2	doc/api: Make attribute listing a consistent style	2018-06-29 11:04:09 +01:00
Sergei Trofimov	39b59e4d79	doc: ouput api: add reference to how-to ... Add a reference to the processing WA output how-to inside the output API docs.	2018-06-28 12:29:07 +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	f4d8b64c8c	doc: Reorder doc pages ... Split glossary into its own section and change the order the pages are displayed.	2018-06-26 16:25:05 +01:00
Marc Bonnici	9403c43a03	doc/agenda_reference: Improve global aliases description	2018-06-26 16:25:05 +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	60e9f08ebc	doc/glossary: Fix incorrect reference for Output Processors entry	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	a64bb3a26f	doc/api: Add workload APIs	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	b6e91630b8	doc/user_reference: Restructure Agenda reference	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
Marc Bonnici	d4aad394d7	doc/index: Update intro paragraph ... Update number of workloads and add note to guide users to the plugin reference for documentation of individual plugins.	2018-06-25 18:19:30 +01:00
Marc Bonnici	df076c68da	templates: Add parameter example to UiAutomator template. ... Add additional information to the UiAutomator template for retrieving parameters.	2018-06-25 18:19:30 +01:00
Marc Bonnici	e672fbed32	doc/execution_model: Add details about optional setup_rerun method	2018-06-25 18:19:30 +01:00
Marc Bonnici	185548d13b	doc/signal_dispatch: Update diagram to incorporate new signals ... Add new signals to diagram and fix incorrect labels.	2018-06-25 18:19:30 +01:00
Sergei Trofimov	03235d0b59	doc: output API restructure part 2 ... - move TargetInfo and RunInfo docs into the new output API doc - remove the old developer_reference/APIs.rst as obsolete - Update output API tag reference to point to the new doc	2018-06-25 17:11:47 +01:00
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
Sergei Trofimov	c400591759	doc: update glossary ... Add a few more terms that have special meaning in the context of WA to the glossary.	2018-06-25 17:11:47 +01:00
Waleed El-Geresy	7941b712c5	docs/user_guide: Fix wa create example command	2018-06-14 15:59:16 +01:00
Sergei Trofimov	5f7fde206d	fw/instrument: add hostside decorator ... Add a decorator to indicate that a callback runs entirely host-side and does not rely on a connection to the target. This means it will be invoked even if the target was detected to be unresponsive.	2018-06-12 16:07:53 +01:00
Marc Bonnici	b4b6f949cc	doc: Add overview of how WA config merging works	2018-06-11 08:10:07 +01:00
Marc Bonnici	aa4dbebcb6	doc: Add initial version of a glossary	2018-06-11 08:10:07 +01:00
Marc Bonnici	b7e17759a3	doc/faq: Add solution for Juno resetting upon commencing a WA run	2018-06-11 08:10:07 +01:00
Marc Bonnici	9d14cb0a48	doc: Update dependencies and installation for Python 3 support	2018-06-11 08:10:07 +01:00
Marc Bonnici	bde3df8172	doc: Restructure API documentation	2018-06-11 08:10:07 +01:00
Marc Bonnici	a425fbf4d3	doc: Add additional API docs	2018-06-11 08:10:07 +01:00
Marc Bonnici	ae09ef174b	doc/method_map_template: Update to refer to signal dispatch diagram	2018-06-11 08:10:07 +01:00