From 4e59ac69d28063825df41e3c8e5001396ab10e32 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Thu, 19 Aug 2021 17:32:31 +0200 Subject: [PATCH] Include a part of README into the Sphinx docs --- README.md | 4 ++++ docs/index.md | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index f1978db321..e988f207be 100644 --- 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 index 15b10361ac..c50cdf6e30 100644 --- 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