Skip to content

Commit 74770d3

Browse files
committed
Fix some typo and minor formatting issues in the docs
1 parent 06780e3 commit 74770d3

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

.readthedocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ build:
55
os: ubuntu-22.04
66
tools:
77
python: "3.11"
8+
apt_packages:
9+
- graphviz
810

911
# Build documentation in the docs/ directory with Sphinx
1012
sphinx:
@@ -23,4 +25,4 @@ python:
2325
- method: pip
2426
path: .
2527
extra_requirements:
26-
- docs
28+
- docs

docs/how_to.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Finally, you can configure what gets rendered by customising the templates.
111111
This is a rather heavy handed approach,
112112
so it should only be necessary when the other options do not give you
113113
the control the you need.
114-
You can learn how to customise the templates in the next section;
114+
You can learn how to customise the templates in the next section:
115115
:ref:`customise-templates`.
116116

117117

@@ -265,7 +265,7 @@ and set :confval:`autodoc_typehints` to ``description`` as normal::
265265

266266
.. note::
267267

268-
Unless :confval:`autodoc_typehints` is set to ``none``,
268+
Unless :confval:`autodoc_typehints` is set to ``None``,
269269
the type annotations of overloads will always be output in the signature
270270
and never merged into the description
271271
because it is impossible to represent all overloads as a list of parameters.

docs/reference/config.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Customisation Options
173173
Default: ``None``
174174

175175
A callback that is called shortly after the Jinja environment is created.
176-
It passed the Jinja environment for editing before template rendering begins.
176+
The callback is passed the Jinja environment for editing before template rendering begins.
177177

178178
The callback should have the following signature:
179179

@@ -189,16 +189,16 @@ Customisation Options
189189
a single page. Valid levels, in descending order of hierarchy, are as
190190
follows:
191191

192-
* ``module``: Packages, modules, subpackages, and submodules.
192+
* ``module``: Packages, modules, subpackages, and submodules.
193193

194-
* ``class``: Classes, exceptions, and all object types mentioned above.
194+
* ``class``: Classes, exceptions, and all object types mentioned above.
195195

196-
* ``function``: Functions, and all object types mentioned above.
196+
* ``function``: Functions, and all object types mentioned above.
197197

198-
* ``method``: Methods, and all object types mentioned above.
198+
* ``method``: Methods, and all object types mentioned above.
199199

200-
* ``attribute``: Class and module level attributes, properties,
201-
and all object types mentioned above.
200+
* ``attribute``: Class and module level attributes, properties,
201+
and all object types mentioned above.
202202

203203

204204
Events

0 commit comments

Comments
 (0)