Skip to content

Commit 2ccae70

Browse files
authored
[docs] Fix typos in autodoc.rst (#12469)
1 parent d42db15 commit 2ccae70

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/usage/extensions/autodoc.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Ensuring the code can be imported
5555
.................................
5656

5757
:mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection after
58-
importing the modules. For importing to work. you have to make sure that your
59-
modules can be found by sphinx and that dependencies can be resolved (if your
58+
importing the modules. For importing to work, you have to make sure that your
59+
modules can be found by Sphinx and that dependencies can be resolved (if your
6060
module does ``import foo``, but ``foo`` is not available in the python environment
6161
that Sphinx runs in, your module import will fail).
6262

@@ -65,16 +65,16 @@ There are two ways to ensure this:
6565
1. Use an environment that contains your package and Sphinx. This can e.g. be your
6666
local dev environment (with an editable install), or an environment in CI in
6767
which you install Sphinx and your package. The regular installation process
68-
ensures that your package can be found by sphinx and that all dependencies are
68+
ensures that your package can be found by Sphinx and that all dependencies are
6969
available.
7070

7171
2. It is alternatively possible to patch the Sphinx run so that it can operate
72-
directly on the sources; e.g. if you want to be able to do a sphinx build from a
72+
directly on the sources; e.g. if you want to be able to do a Sphinx build from a
7373
source checkout.
7474

7575
- Patch :data:`sys.path` in your Sphinx :file:`conf.py` to include the folder of
7676
your sources. E.g. if you have a repository structure with :file:`doc/conf.py`
77-
and your package is at :file:`src/mypackage`, then you sould add::
77+
and your package is at :file:`src/mypackage`, then you should add::
7878

7979
sys.path.insert(0, os.path.abspath('../src'))
8080

0 commit comments

Comments
 (0)