Skip to content

Commit

Permalink
more formatting changes
Browse files Browse the repository at this point in the history
  • Loading branch information
elpham6 authored and elpham6 committed May 9, 2024
1 parent cdfc5ce commit 301b5f7
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@ In this guide, the ``src`` folder should have a **calculator.py** and **hellowor

- Run ``sphinx-quickstart``. You will be prompted with the following:

1. **Separate source and build directories (y/n) [n]**:

Select `n`.
1. **Separate source and build directories (y/n) [n]**: Select `n`.

2. **Project name**: enter your project name here

Expand Down Expand Up @@ -127,6 +125,7 @@ For this tutorial, add the following extensions to the ``extensions`` list in **
}
Then, add the ``linkcode`` settings:
.. code-block:: python
Expand Down Expand Up @@ -181,7 +180,7 @@ Below are some examples of what you can add to the documentation.
7.1. Showing More Content on Homepage
--------------------------------------

For example, when you view your homepage, you will only see the index menu and not the content of your code.
By default, when you view your homepage, you will only see the index menu and not the content of your code.
To see the contents of your modules, open ``index.rst`` and manually add `.rst` file names to Contents:

.. code-block:: rst
Expand Down

0 comments on commit 301b5f7

Please sign in to comment.