docs: new improved documentation

The current Avocado documentation is outdated and a bit confusing for new users. Documentation is one of the starting points for understanding how Avocado works and deciding whether to use it or not. This change splits the current documentation into guides and chapters to improve the readability and reduce the learning curve. During this process I tried to change as minimum as possible the current content and added only few sections mainly on Contributor's Guide. Signed-off-by: Beraldo Leal <[email protected]>
ana · Nov 19, 2019 · c424c79 · c424c79
1 parent 072d8aa
commit c424c79
Show file tree

Hide file tree

Showing 140 changed files with 3,412 additions and 3,137 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,8 @@ sysinfo-*
 MANIFEST
 dist
 *.egg-info*
+docs/source/api/core
+docs/source/api/test
+docs/source/api/utils
+docs/source/api/plugins
+docs/source/api/optional-plugins
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1 +1 @@
-docs/source/ContributionGuide.rst
+docs/source/guides/contributor/index.rst
diff --git a/docs/source/.include/helpus.rst b/docs/source/.include/helpus.rst
@@ -0,0 +1 @@
+.. attention:: TODO: This section needs attention! Please, help us contributing on this document.
diff --git a/docs/source/ContributionGuide.rst b/docs/source/ContributionGuide.rst
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		docs/source/ContributionGuide.rst
		docs/source/guides/contributor/index.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. attention:: TODO: This section needs attention! Please, help us contributing on this document.