Skip to content

Commit

Permalink
[TASK] Overhaul reST start page and menu structure (#392)
Browse files Browse the repository at this point in the history
Co-authored-by: lina.wolf <[email protected]>
  • Loading branch information
github-actions[bot] and linawolf authored Jan 30, 2024
1 parent c79b975 commit 7949948
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 47 deletions.
8 changes: 4 additions & 4 deletions Documentation/WritingReST/BasicRestSyntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
.. index:: reST; Syntax
.. _basic-rest-syntax:

==========================
Basic reST & Sphinx syntax
==========================
=============================
Basic reStructuredText syntax
=============================

The .rst files are written in reStructuredText (reST) format. They
The `.rst` files are written in reStructuredText (reST) format. They
contain text with additional markup.


Expand Down
6 changes: 3 additions & 3 deletions Documentation/WritingReST/CheatSheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
.. index:: reST; Cheat sheet
.. _rest-cheat-sheet:

==========================
Cheat sheet: reST & Sphinx
==========================
=============================
Cheat sheet: reStructuredText
=============================

:ref:`Headlines <Headlines-and-sections>`
=========================================
Expand Down
62 changes: 25 additions & 37 deletions Documentation/WritingReST/Index.rst
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
6 changes: 3 additions & 3 deletions Documentation/WritingReST/Reference/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
.. index:: reST; Reference
.. _rest-reference:

========================
Reference: reST & Sphinx
========================
===========================
Reference: reStructuredText
===========================

.. toctree::
:titlesonly:
Expand Down

0 comments on commit 7949948

Please sign in to comment.