1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 10:51:13 +01:00
Commit Graph

11 Commits

Author SHA1 Message Date
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
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
aa4dbebcb6 doc: Add initial version of a glossary 2018-06-11 08:10:07 +01:00
Marc Bonnici
dbe98edd7d doc: Reword introduction paragraph 2018-06-11 08:10:07 +01:00
Marc Bonnici
4f295af96c doc/index: Update intro description of WA. 2018-05-21 10:26:28 +01:00
Sergei Trofimov
b1b2131b0c doc: fix build warnings 2018-05-18 10:32:08 +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
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
Sebastian Goscik
c51593a729 pluginloader: Updated documentation to say plugin instead of extension 2016-09-27 11:17:25 +01:00
Sergei Trofimov
a747ec7e4c Initial commit of open source Workload Automation. 2015-03-10 13:09:31 +00:00