Skip to content

Commit 4043094

Browse files
plaindocshumitos
andauthored
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]>
1 parent c3a0268 commit 4043094

File tree

8 files changed

+413
-213
lines changed

8 files changed

+413
-213
lines changed

common

docs/user/index.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Read the Docs: documentation simplified
77
:caption: Getting started
88

99
/tutorial/index
10-
/intro/getting-started-with-sphinx
11-
/intro/getting-started-with-mkdocs
10+
/intro/doctools
11+
/intro/mkdocs
12+
/intro/sphinx
1213
/intro/add-project
1314
/examples
1415

docs/user/intro/doctools.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Supported tools
2+
===============
3+
4+
Read the Docs provides hosting for static html documentation generated by Sphinx,
5+
MkDocs, Docusaurus and a variety of other tools.
6+
7+
Here are minimal configuration examples for some common tools,
8+
with more coming soon.
9+
10+
.. grid:: 2
11+
12+
.. grid-item-card:: Material for MkDocs
13+
:link: mkdocs.html
14+
15+
Material for MkDocs is a powerful documentation framework on top of MkDocs.
16+
17+
Supported formats
18+
:bdg-success:`md`
19+
Written in
20+
:bdg-info:`python`
21+
22+
23+
.. grid-item-card:: Sphinx
24+
:link: sphinx.html
25+
26+
Sphinx is a powerful documentation generator that has many features for writing technical documentation.
27+
28+
Supported formats
29+
:bdg-success:`rst` :bdg-success:`md`
30+
Written in
31+
:bdg-info:`python`

docs/user/intro/getting-started-with-mkdocs.rst

-87
This file was deleted.

docs/user/intro/getting-started-with-sphinx.rst

-119
This file was deleted.

0 commit comments

Comments
 (0)