Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
DOC: Fix cut passages from README in documentation index file
Browse files Browse the repository at this point in the history
Fix cut passages from `README` in documentation index file: remove the
`start-line` and `end-line` directives and include the `README` file
entirely.

The `start-line` and `end-line` directives were making such that
relevant passages of the `README` file providing context for the
tool were not being included. Thus the text shown in the documentation
index file had some missing parts, and was not making sense.

Do not include the `eddymotion-flowchart.svg` figure: it is already
contained in the `README` file.
  • Loading branch information
jhlegarreta committed Nov 27, 2024
1 parent f10fc12 commit 82ba295
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
.. include:: links.rst
.. include:: ../README.rst
:end-line: 29
.. include:: ../README.rst
:start-line: 34


.. image:: _static/eddymotion-flowchart.svg
:alt: The eddymotion flowchart

Contents
--------
Expand Down

0 comments on commit 82ba295

Please sign in to comment.