Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Reframe Supported Tools #11853

Merged
merged 2 commits into from
Dec 13, 2024
Merged

docs: Reframe Supported Tools #11853

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43623b0
docs: Reframe Supported Tools
ericholscher Dec 13, 2024
f5017f3
Update docs/user/intro/doctools.rst
ericholscher Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/user/intro/doctools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
Supported tools
===============
Popular Documentation Tools
===========================
ericholscher marked this conversation as resolved.
Show resolved Hide resolved

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
Loading