From cd644786093959c5e59c98398871d94bdad75683 Mon Sep 17 00:00:00 2001 From: Eric Holscher <25510+ericholscher@users.noreply.github.com> Date: Fri, 13 Dec 2024 08:40:37 -0800 Subject: [PATCH] docs: Reframe Supported Tools (#11853) We don't want make it sound like we don't support any doc tool, but these are just some of the popular ones. I think this framing works well. --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11853.org.readthedocs.build/en/11853/ - Developer's documentation (`dev`): https://dev--11853.org.readthedocs.build/en/11853/ --------- Co-authored-by: Manuel Kaufmann --- docs/user/intro/doctools.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/user/intro/doctools.rst b/docs/user/intro/doctools.rst index 981710a6db7..7a1c491935e 100644 --- a/docs/user/intro/doctools.rst +++ b/docs/user/intro/doctools.rst @@ -1,11 +1,16 @@ -Supported tools -=============== +Popular documentation tools +=========================== -Read the Docs provides hosting for static html documentation generated by Sphinx, -MkDocs, Docusaurus and a variety of other tools. +Read the Docs provides documentation hosting for any tool that can output HTML. +We provide a number of features on top of that that is well-suited to documentation specifically, +but you can host any kind of HTML content on Read the Docs. -Here are minimal configuration examples for some common tools, -with more coming soon. +Below is a list of popular documentation tools that you can use to write your documentation. + +.. seealso:: + + :doc:`/build-customization` + Learn how to build documentation with any tool. .. grid:: 2