Skip to content

Commit 3354113

Browse files
committed
Remove :caption: in README.rst to fix rendering on github
I forgot github doesn't provide all sphinx features.
1 parent 67d35ee commit 3354113

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ In order to activate the autodocsumm extension, you have to list it in your
100100
``conf.py``:
101101

102102
.. code-block:: python
103-
:caption: conf.py
104103
105104
extensions = [
106105
'sphinx.ext.autodoc',
@@ -117,10 +116,9 @@ directives to generate a table at the top, e.g.:
117116
:autosummary:
118117
119118
Optionally, you can make autodocsumm active by default for all autodoc
120-
directives by adding:
119+
directives by adding in ``conf.py``:
121120

122121
.. code-block:: python
123-
:caption: conf.py
124122
125123
autodoc_default_options = {
126124
'autosummary': True,

0 commit comments

Comments
 (0)