From d425ea8d962edb6145bacdb96f45cbb8042430fb Mon Sep 17 00:00:00 2001 From: elpham6 Date: Thu, 9 May 2024 02:13:28 -0400 Subject: [PATCH] update conf.py --- README.rst | 24 ++++++++++-------------- docs/conf.py | 2 +- src/calculator.py | 2 -- 3 files changed, 11 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index cf829a6..72db989 100644 --- a/README.rst +++ b/README.rst @@ -96,7 +96,15 @@ Add the following to the beginning of **conf.py**: Sphinx has many useful extensions, which you can check out `here `_. -For this tutorial, add the following extensions to the ``extensions`` list: +For this tutorial, add the following extensions to the ``extensions`` list in **conf.py**: + +.. code-block:: python + + extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx.ext.linkcode", + ] - ``sphinx.ext.autodoc``: automatically takes doc strings from your Python files @@ -139,18 +147,6 @@ For this tutorial, add the following extensions to the ``extensions`` list: Adjust the config according to your folder structure and names. If you would like a different type of output, refer to Sphinx's `configuration documentation `_. - -The resulting ``extensions`` list should look like this: - -.. code-block:: python - - extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.napoleon", - "sphinx.ext.linkcode", - ] - - 5.3 Theme (Optional) -------------------- @@ -168,7 +164,7 @@ This tutorial uses a Sphinx theme called `Read the Docs