From 794994841a33402ac1ddc7d391180b22f62b83d0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 30 Jan 2024 19:07:22 +0100 Subject: [PATCH] [TASK] Overhaul reST start page and menu structure (#392) Co-authored-by: lina.wolf --- Documentation/WritingReST/BasicRestSyntax.rst | 8 +-- Documentation/WritingReST/CheatSheet.rst | 6 +- Documentation/WritingReST/Index.rst | 62 ++++++++----------- Documentation/WritingReST/Reference/Index.rst | 6 +- 4 files changed, 35 insertions(+), 47 deletions(-) diff --git a/Documentation/WritingReST/BasicRestSyntax.rst b/Documentation/WritingReST/BasicRestSyntax.rst index df0d683f..1b08e071 100644 --- a/Documentation/WritingReST/BasicRestSyntax.rst +++ b/Documentation/WritingReST/BasicRestSyntax.rst @@ -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. diff --git a/Documentation/WritingReST/CheatSheet.rst b/Documentation/WritingReST/CheatSheet.rst index 1c953830..9ec82b2f 100644 --- a/Documentation/WritingReST/CheatSheet.rst +++ b/Documentation/WritingReST/CheatSheet.rst @@ -14,9 +14,9 @@ .. index:: reST; Cheat sheet .. _rest-cheat-sheet: -========================== -Cheat sheet: reST & Sphinx -========================== +============================= +Cheat sheet: reStructuredText +============================= :ref:`Headlines ` ========================================= diff --git a/Documentation/WritingReST/Index.rst b/Documentation/WritingReST/Index.rst index 6b8b6f76..09372633 100644 --- a/Documentation/WritingReST/Index.rst +++ b/Documentation/WritingReST/Index.rst @@ -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 - `__ +* `reSTructuredText reference by Sphinx `__ +* `reSTructuredText introduction on docutils `__ +* `reStructuredText Markup Specification `__ -.. toctree:: - :hidden: +.. toctree:: + :hidden: - Introduction - BasicRestSyntax - CheatSheet - Reference/Index + Introduction + BasicRestSyntax + CheatSheet + Reference/Index diff --git a/Documentation/WritingReST/Reference/Index.rst b/Documentation/WritingReST/Reference/Index.rst index 2ff09136..a981a593 100644 --- a/Documentation/WritingReST/Reference/Index.rst +++ b/Documentation/WritingReST/Reference/Index.rst @@ -3,9 +3,9 @@ .. index:: reST; Reference .. _rest-reference: -======================== -Reference: reST & Sphinx -======================== +=========================== +Reference: reStructuredText +=========================== .. toctree:: :titlesonly: