Skip to content

Commit

Permalink
change readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
elpham6 authored and elpham6 committed May 9, 2024
1 parent 61c3c4f commit 7b19949
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ Let's create a section for some example codes. We will use ``sphinx_gallery`` ex
'plot_gallery': 'False',
}
4. In the ``examples`` folder, create a **README.rst** or **README.txt** file.
A readme file is necessary for sphinx_gallery to generate documentation. Copy/paste this text:

Expand All @@ -262,6 +263,7 @@ A readme file is necessary for sphinx_gallery to generate documentation. Copy/pa
This folder contains example code for the **calculator.py** module.
5. From ``docs``, run ``make html``. There is a new folder called ``auto_examples`` created in ``docs``, with all the generated
documentation for modules in the ``examples`` folder.

Expand Down

0 comments on commit 7b19949

Please sign in to comment.