75 Commits

Author	SHA1	Message	Date
Marc Bonnici	a32e7e7bc7	doc/plugin: Add instrument backends to plugin reference ... Add documentation for the energy instrument.	2018-05-24 16:57:47 +01:00
Marc Bonnici	bbb5cb9643	doc/build_plugin_docs: Only load the required plugins ... When updating the pluginload only load the modules we want to document rather than load all avalible and then filter.	2018-05-24 16:57:47 +01:00
Marc Bonnici	cacc4dec8b	doc: Update RebootPolicy and ExectionOrder information	2018-05-23 10:14:34 +01:00
Marc Bonnici	bea36cc398	doc: Update output_api references	2018-05-21 10:26:28 +01:00
Marc Bonnici	04fe3768af	doc: Misc fixes ... Fix typos, formatting and irrelevant information.	2018-05-21 10:26:28 +01:00
Marc Bonnici	f4dd1a1c84	doc/migration_guide: Add additional parameter changes	2018-05-21 10:26:28 +01:00
Marc Bonnici	4f295af96c	doc/index: Update intro description of WA.	2018-05-21 10:26:28 +01:00
Marc Bonnici	978d43b33d	doc: Update linaro link	2018-05-21 10:26:28 +01:00
Marc Bonnici	b3d34e25ff	doc: Update sysfile documentation. ... Remove duplicated information and added link to additional documentation.	2018-05-21 10:26:28 +01:00
Marc Bonnici	700989298c	doc: Correct ID names	2018-05-21 10:26:28 +01:00
Marc Bonnici	69462e54a1	doc: Update APK workload parameter descriptions. ... Clarify parameter descriptions.	2018-05-21 10:26:28 +01:00
Marc Bonnici	5c6cc87105	doc: Update sections example. ... Modify documention and example to better explain sections	2018-05-21 10:26:28 +01:00
Marc Bonnici	b7c70aabae	doc: Remove run_config directory` ... Remove auto generated run_config directory, add to .gitignore and clear on `make clean`	2018-05-21 10:26:28 +01:00
Marc Bonnici	52b2df427e	doc/show_cmd: Reword description and add settings option	2018-05-21 10:26:28 +01:00
Marc Bonnici	9986423365	doc: Add documentation for the process command	2018-05-21 10:26:28 +01:00
Sergei Trofimov	192bebbc23	doc: update and extend Output docs ... - Move output processing API docs into developer reference. - Add a section on output directory structure to user reference. - Rewrite the output section of the user guide to provide a very brief overview of the output directory and to link to the two sections above.	2018-05-18 17:52:49 +01:00
Sergei Trofimov	050722ee8f	doc: user_guide: add a note about show command ... Add a note describing the usage of "wa show"	2018-05-18 16:50:48 +01:00
Sergei Trofimov	b1b2131b0c	doc: fix build warnings	2018-05-18 10:32:08 +01:00
Sergei Trofimov	d0368cf176	doc: re-write augmentations docs ... Rewrite the "Output processors and Instruments" section into "Augmentations" section.	2018-05-14 17:08:14 +01:00
Sergei Trofimov	c6fae6fa55	doc: update how-tos' titles ... Update agenda and revent how-tos' titles to be more informative.	2018-05-14 17:08:14 +01:00
Sergei Trofimov	ee7734efd7	doc: agenda: add note about plugin names ... Add a note explaining how plugin names are treated, and which names are considered to be identical.	2018-05-14 17:08:14 +01:00
Sergei Trofimov	06b64de1be	doc: user guide: fix result --> output ... Fix an old reference to "result processors", correcting it to "output processors".	2018-05-14 17:08:14 +01:00
Marc Bonnici	66fa8c856a	doc: Fix code highlighting	2018-05-14 16:34:10 +01:00
Marc Bonnici	c12bdea1af	doc/requirements: Fix online code highlighting ... The default version of the readthedocs theme does not support code highlighting correctly so manually specify a compatible version as per https://github.com/rtfd/readthedocs.org/issues/4072	2018-05-14 16:34:10 +01:00
Marc Bonnici	2a66e40d9b	doc/config: Do not generate API documentation ... On the latest version of Sphinx the way we were doing API generation caused issues. Due to the structure/formatting of our code base the output was not very useful anyway so remove the automatic generation with the aim to manually document the relevant API in the future.	2018-05-14 16:34:10 +01:00
Marc Bonnici	087c18c752	doc/migration_guide: Add references to confvalues	2018-05-11 18:06:24 +01:00
Marc Bonnici	19184ceaf6	doc: Update reference and fix typos	2018-05-11 18:06:24 +01:00
Marc Bonnici	86cc449203	doc: Improve description of context methods	2018-05-11 18:06:24 +01:00
Marc Bonnici	48a7ad9415	doc/output: Update output directory information	2018-05-11 18:06:24 +01:00
Marc Bonnici	9d0127d685	doc/installation: Fix formatting	2018-05-11 18:06:24 +01:00
Marc Bonnici	9251febafb	doc/build_plugin_doc: Fix typo in function name	2018-05-11 18:06:24 +01:00
sergei Trofimov	1e750c659b	utils/log: add early record buffering ... Buffer early log records until a log file becomes available, flush records to said file afterwards. This ensures that early log output, which, among other things, contains plugin discovery logging, is not lost. Buffer capacity is configurable via an environment variable.	2018-05-09 15:06:31 +01:00
Marc Bonnici	98e86efbda	doc: Fix references	2018-04-30 09:14:22 +01:00
Marc Bonnici	2aeaedb8bc	doc/build_plugin_docs: Improve plugin formatting. ... Add a table of contents to the plugin list page along with page breaks to divide things up.	2018-04-30 09:14:22 +01:00
Marc Bonnici	7cb11f66cf	doc: add building of instrument method map	2018-04-30 09:14:22 +01:00
Marc Bonnici	9741014b35	doc: Fix formatting errors	2018-04-30 09:14:22 +01:00
Marc Bonnici	0fd095622c	doc: Improve installing executables documentation	2018-04-30 09:14:22 +01:00
Marc Bonnici	1f9a233214	doc/agenda: Add documentation about classifiers	2018-04-30 09:14:22 +01:00
Marc Bonnici	c1171263f9	doc/faq: Add solution to "Unknown runtime parameter"	2018-04-30 09:14:22 +01:00
Marc Bonnici	504703d444	doc/migration_guide: Fix typo	2018-04-30 09:14:22 +01:00
Marc Bonnici	61a9c96a7d	doc/device_setup: Add examples of installing modules to target	2018-04-30 09:14:22 +01:00
Marc Bonnici	f60b7eca16	doc/output_api: Improve examples	2018-04-30 09:14:22 +01:00
Marc Bonnici	8c9c1a8f1e	docs/user_guide: Clarify basic run command information.	2018-04-30 09:14:22 +01:00
Marc Bonnici	81c6da9c2c	Documentation: Add support for generating common target api	2018-04-30 09:14:22 +01:00
Marc Bonnici	d3efb1fda1	doc/requirements: Add explict requirements for numpy and pandas ... Add these requirements so that they are installed into the readthedocs environment before building the documentation. If left to use the default installation method the build process times out.	2018-04-24 09:59:57 +01:00
Marc Bonnici	bc87eacde2	Documentation: Update WA3 Documentation ... Update the documentation and build system for producing documentation for WA3 with support for automatic building on readthedocs. Note: This is currently a WIP.	2018-04-24 09:59:57 +01:00
Marc Bonnici	1fede5e3f3	doc/build_plugin_docs: Add support for core config generation	2018-04-24 09:59:57 +01:00
Sergei Trofimov	60fbd17fab	doc/revent: add missing verbatim block markup	2018-02-22 08:41:04 +00:00
Sergei Trofimov	87667cd161	doc/revent: fix event field descriptions ... Fix the field descriptions for replay event to reflect the correct signedness and size. (note: the layout diagrams were already correct, just the textual descriptions needed to be adjusted)	2018-02-22 08:41:04 +00:00
Sergei Trofimov	7cdb32c7f8	doc: update revent documentation ... Forward-port the updated revent documentation from WA2, including recording format description.	2017-09-27 10:34:48 +01:00