Skip to content

Commit

Permalink
docs: Reframe Supported Tools (#11853)
Browse files Browse the repository at this point in the history
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.


<!-- readthedocs-preview docs start -->
---
:books: Documentation previews :books:

- User's documentation (`docs`):
https://docs--11853.org.readthedocs.build/en/11853/

<!-- readthedocs-preview docs end -->

<!-- readthedocs-preview dev start -->
- Developer's documentation (`dev`):
https://dev--11853.org.readthedocs.build/en/11853/

<!-- readthedocs-preview dev end -->

---------

Co-authored-by: Manuel Kaufmann <[email protected]>
  • Loading branch information
ericholscher and humitos authored Dec 13, 2024
1 parent bb2aca3 commit cd64478
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/user/intro/doctools.rst
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit cd64478

Please sign in to comment.