From 301b5f7e2419dfcb1bd6e87b9d39225cc696adc0 Mon Sep 17 00:00:00 2001 From: elpham6 <ilyanairvine@LAPTOP-OJ1D9TIE> Date: Thu, 9 May 2024 14:28:22 -0400 Subject: [PATCH] more formatting changes --- README.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 2194a80..b3f4f06 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -127,6 +125,7 @@ For this tutorial, add the following extensions to the ``extensions`` list in ** } + Then, add the ``linkcode`` settings: .. code-block:: python @@ -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