Skip to content

Commit b6113b6

Browse files
committed
Regen API docs, fix webhook docs, fix doc-building docs in README
1 parent b92af86 commit b6113b6

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ Of particular use is the "How to write plugins" section.
6161

6262
You can build the documentation yourself with::
6363

64-
$ pip install sphinx
65-
$ cd docs/
64+
$ pip install -r requirements.docs.txt
65+
$ cd doc/
66+
$ ./regen_apidoc.sh
6667
$ make html
6768

6869
Testing

doc/api/csbot.plugins.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Submodules
55
----------
66

77
.. toctree::
8+
:maxdepth: 4
89

910
csbot.plugins.auth
1011
csbot.plugins.calc

doc/api/csbot.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ Subpackages
55
-----------
66

77
.. toctree::
8+
:maxdepth: 4
89

910
csbot.plugins
1011

1112
Submodules
1213
----------
1314

1415
.. toctree::
16+
:maxdepth: 4
1517

1618
csbot.cli
1719
csbot.config

src/csbot/plugins/github.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
104104
Module contents
105105
===============
106-
"""
106+
""" # noqa: E501
107107
import hmac
108108
import datetime
109109
import json

src/csbot/plugins/webhook.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ async def webhook(self, e):
1616
Configuration
1717
=============
1818
19-
The following configuration options are supported in the ``[webserver]`` config section:
19+
The following configuration options are supported in the ``[webhook]`` config section:
2020
2121
================== ===========
2222
Setting Description

0 commit comments

Comments
 (0)