Add list of supported tools (#11547)

* Fix indent * Noodling on doctools * Pre-commit * Remove mkdocs getting started guide * Typo * Skip jsdoc for now * Add clarity on mkdocs vs material * link fix * WIP * Review feedback * Remove Getting Started with Sphinx * Remove links as well * Some updates to Sphinx and MkDocs pages * Directive not installed * WIP * Shorter! * Add canonical url for sphinx * Add see also * Complete instructions * Add test card display * Update deps * Alternate layout using only sphinx-design, with clickable cards * Add language and markup info the main pages * Revert unused dependencies * Revert unused dependencies * Apply suggestions from code review * Use the full feature branch for now * Style * Comment addons flyout section for now --------- Co-authored-by: Manuel Kaufmann <[email protected]>
readthedocs · Sep 23, 2024 · 4043094 · 4043094
1 parent c3a0268
commit 4043094
Show file tree

Hide file tree

Showing 8 changed files with 413 additions and 213 deletions.
diff --git a/common b/common
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -7,8 +7,9 @@ Read the Docs: documentation simplified
    :caption: Getting started
 
    /tutorial/index
-   /intro/getting-started-with-sphinx
-   /intro/getting-started-with-mkdocs
+   /intro/doctools
+   /intro/mkdocs
+   /intro/sphinx
    /intro/add-project
    /examples
 

diff --git a/docs/user/intro/doctools.rst b/docs/user/intro/doctools.rst
@@ -0,0 +1,31 @@
+Supported tools
+===============
+
+Read the Docs provides hosting for static html documentation generated by Sphinx,
+MkDocs, Docusaurus and a variety of other tools.
+
+Here are minimal configuration examples for some common tools,
+with more coming soon.
+
+.. grid:: 2
+
+    .. grid-item-card::  Material for MkDocs
+        :link: mkdocs.html
+
+        Material for MkDocs is a powerful documentation framework on top of MkDocs.
+
+        Supported formats
+             :bdg-success:`md`
+        Written in
+             :bdg-info:`python`
+
+
+    .. grid-item-card::  Sphinx
+        :link: sphinx.html
+
+        Sphinx is a powerful documentation generator that has many features for writing technical documentation.
+
+        Supported formats
+             :bdg-success:`rst` :bdg-success:`md`
+        Written in
+             :bdg-info:`python`
diff --git a/docs/user/intro/getting-started-with-mkdocs.rst b/docs/user/intro/getting-started-with-mkdocs.rst
diff --git a/docs/user/intro/getting-started-with-sphinx.rst b/docs/user/intro/getting-started-with-sphinx.rst