mirror of
				https://github.com/ARM-software/workload-automation.git
				synced 2025-10-30 22:54:18 +00:00 
			
		
		
		
	doc: Restructure
Restructure the documentation to be split into `User Information` and `Developer Information`, and split the how to guides into their corresponding section.
This commit is contained in:
		| @@ -37,32 +37,14 @@ User Information | ||||
| ================ | ||||
|  | ||||
| This section lists general usage documentation. If you're new to WA3, it is | ||||
| recommended you start with the :doc:`user_guide` page. This section also contains | ||||
| recommended you start with the :ref:`User Guide <user-guide>` page. This section also contains | ||||
| installation and configuration guides. | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|  | ||||
|    installation | ||||
|    user_guide | ||||
|    user_reference | ||||
|  | ||||
|  | ||||
| How To Guides | ||||
| =============== | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 3 | ||||
|  | ||||
|    how_to | ||||
|    user_information | ||||
|  | ||||
| FAQ | ||||
| ==== | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|  | ||||
|    faq | ||||
|  | ||||
| .. _in-depth: | ||||
|  | ||||
| @@ -73,9 +55,9 @@ This section contains more advanced topics, such how to write your own Plugins | ||||
| and detailed descriptions of how WA functions under the hood. | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|    :maxdepth: 3 | ||||
|  | ||||
|    developer_reference | ||||
|    developer_information | ||||
|  | ||||
|  | ||||
| References | ||||
| @@ -87,7 +69,6 @@ References | ||||
|    plugins | ||||
|    glossary | ||||
|  | ||||
|  | ||||
| API | ||||
| === | ||||
|  | ||||
| @@ -96,9 +77,10 @@ API | ||||
|  | ||||
|     api | ||||
|  | ||||
| .. Indices and tables | ||||
| .. ================== | ||||
| FAQ | ||||
| ==== | ||||
|  | ||||
| .. .. * :ref:`genindex` | ||||
| .. .. * :ref:`modindex` | ||||
| .. * :ref:`search` | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|  | ||||
|    faq | ||||
|   | ||||
		Reference in New Issue
	
	Block a user