Skip to content

Commit

Permalink
change readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
elpham6 authored and elpham6 committed May 9, 2024
1 parent 42bdb65 commit d812c52
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,7 @@ You can also move back and forth between the sections of the documentation using

Let's create a section called Demo Modules Overview, where we can write more explanation on the code.

1. In ``docs``, create a file called **overview.rst**, **overview.calculator.rst** and **overview.helloworld.rst**.
For this turorial, simply copy the files from the ``docs`` folder of `this <https://github.com/elpham6/sphinx_demo/tree/main/docs>`_ repo to your own repo.
1. In ``docs``, create a file called **overview.rst**, **overview.calculator.rst** and **overview.helloworld.rst**. For this turorial, simply copy the files from the ``docs`` folder of `this <https://github.com/elpham6/sphinx_demo/tree/main/docs>`_ repo to your own repo.

2. To add this Demo Modules Overview section, open **index.rst**. Add **overview** to the top of the ``toctree``.

Expand Down

0 comments on commit d812c52

Please sign in to comment.