-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Overhaul reST start page and menu structure (#392)
Co-authored-by: lina.wolf <[email protected]>
- Loading branch information
1 parent
c79b975
commit 7949948
Showing
4 changed files
with
35 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,37 @@ | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: rst | ||
.. index:: | ||
! reST | ||
reStructuredText | ||
see: reStructuredText; reST | ||
! Sphinx | ||
.. _Formatting-with-reST: | ||
.. _format-sphinx: | ||
.. _rest-quick-start: | ||
|
||
========================= | ||
reStructuredText & Sphinx | ||
========================= | ||
|
||
This chapter is an introduction and reference for writing documentation using reStructuredText | ||
(also referred to as reST) and Sphinx. | ||
.. include:: /Includes.rst.txt | ||
.. highlight:: rst | ||
.. index:: | ||
reStructuredText | ||
reST | ||
.. _Formatting-with-reST: | ||
.. _format-sphinx: | ||
.. _rest-quick-start: | ||
|
||
================ | ||
reStructuredText | ||
================ | ||
|
||
This chapter is an introduction and reference for writing documentation using | ||
reStructuredText (also referred to as reST). | ||
|
||
It is recommended to read (or at least browse through) | ||
the :ref:`writing-rest-introduction` and the general | ||
:ref:`format-rest-cgl` first. | ||
|
||
You don't need to read the entire chapter, just lookup | ||
the section that is relevant for what you plan to do. | ||
|
||
Or, use the :ref:`rest-cheat-sheet`, which contains the most commonly used | ||
markup on one page. | ||
|
||
We won't be covering every reST markup that is | ||
We cannot cover every reST markup that is | ||
available. For more information, see other resources, such as: | ||
http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html | ||
|
||
.. tip:: | ||
|
||
See the t3SphinxThemeRtd demo docs for more examples. | ||
|
||
.. rst-class:: horizbuttons-striking-m | ||
|
||
- `➜ See the T3SphinxThemeRtd DemoDocs | ||
<https://docs.typo3.org/typo3cms/drafts/github/TYPO3-Documentation/t3SphinxThemeRtdDemoDocs/Index.html>`__ | ||
|
||
* `reSTructuredText reference by Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`__ | ||
* `reSTructuredText introduction on docutils <https://docutils.sourceforge.io/rst.html>`__ | ||
* `reStructuredText Markup Specification <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`__ | ||
|
||
.. toctree:: | ||
:hidden: | ||
.. toctree:: | ||
:hidden: | ||
|
||
Introduction | ||
BasicRestSyntax | ||
CheatSheet | ||
Reference/Index | ||
Introduction | ||
BasicRestSyntax | ||
CheatSheet | ||
Reference/Index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters