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.

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

Add list of supported tools #11547

Merged
merged 32 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
a2664e9
Fix indent
plaindocs Aug 8, 2024
65ee55f
Noodling on doctools
plaindocs Aug 15, 2024
2a6841d
Pre-commit
plaindocs Aug 15, 2024
37fa1bc
Remove mkdocs getting started guide
plaindocs Aug 15, 2024
5b80ab0
Typo
plaindocs Aug 28, 2024
6951e80
Skip jsdoc for now
plaindocs Aug 28, 2024
58d8813
Add clarity on mkdocs vs material
plaindocs Aug 28, 2024
1b2d18b
link fix
plaindocs Aug 28, 2024
1ce3d13
WIP
plaindocs Aug 28, 2024
b88a5b7
Merge resolution
plaindocs Sep 2, 2024
cc2d731
Review feedback
plaindocs Sep 2, 2024
f81c7f7
Remove Getting Started with Sphinx
plaindocs Sep 2, 2024
d0ed336
Remove links as well
plaindocs Sep 2, 2024
512ab07
Some updates to Sphinx and MkDocs pages
plaindocs Sep 3, 2024
6de7081
Directive not installed
plaindocs Sep 3, 2024
67e527b
WIP
plaindocs Sep 5, 2024
7a1527e
Shorter!
plaindocs Sep 5, 2024
4b52512
Add canonical url for sphinx
plaindocs Sep 5, 2024
dc63be4
Add see also
plaindocs Sep 5, 2024
7f8dfac
Complete instructions
plaindocs Sep 5, 2024
c7216e9
Add test card display
plaindocs Sep 5, 2024
925201c
Update deps
plaindocs Sep 5, 2024
846e023
Alternate layout using only sphinx-design, with clickable cards
plaindocs Sep 10, 2024
ed52f95
Add language and markup info the main pages
plaindocs Sep 19, 2024
ff08201
Merge conflict resolution
plaindocs Sep 19, 2024
d5d28aa
Revert unused dependencies
plaindocs Sep 19, 2024
7af7023
Revert unused dependencies
plaindocs Sep 19, 2024
3f46052
Apply suggestions from code review
humitos Sep 23, 2024
a70b7be
Use the full feature branch for now
humitos Sep 23, 2024
06c0c1e
Style
humitos Sep 23, 2024
eb71007
Comment addons flyout section for now
humitos Sep 23, 2024
3a3b956
Merge branch 'main' into sam/doctools
humitos Sep 23, 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
2 changes: 1 addition & 1 deletion common
5 changes: 3 additions & 2 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
31 changes: 31 additions & 0 deletions docs/user/intro/doctools.rst
plaindocs marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -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`
87 changes: 0 additions & 87 deletions docs/user/intro/getting-started-with-mkdocs.rst

This file was deleted.

119 changes: 0 additions & 119 deletions docs/user/intro/getting-started-with-sphinx.rst

This file was deleted.

Loading