Include a part of README into the Sphinx docs

webknjaz · Aug 20, 2021 · 4e59ac6 · 4e59ac6
1 parent 9667393
commit 4e59ac6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,15 @@
 # ansible-navigator
 
+[//]: # (DO-NOT-REMOVE-docs-intro-START)
+
 A text-based user interface (TUI) for the Red Hat Ansible Automation Platform.
 
 A demo of the interface can be found [on youtube][YT demo].
 
 [YT demo]: https://www.youtube.com/watch?v=J9PBKi8ydi4
 
+[//]: # (DO-NOT-REMOVE-docs-intro-END)
+
 ## Quick start
 
 ### Installing

diff --git a/docs/index.md b/docs/index.md
@@ -3,6 +3,11 @@
 
 `ansible-navigator` is a command based tool for creating, reviewing, and troubleshooting Ansible content, including inventories, playbooks, and collections.
 
+```{include} ../README.md
+:start-after: (DO-NOT-REMOVE-docs-intro-START)
+:end-before: (DO-NOT-REMOVE-docs-intro-END)
+```
+
 
 ```{toctree}
 :maxdepth: 2