Skip to content

Commit 645fbd5

Browse files
alanbriolatalanbriolat
authored
Merge pull request #170 from alanbriolat/cleanup
Cleanup
2 parents 63ac305 + b6113b6 commit 645fbd5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+787
-921
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.cli.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
csbot.cli module
2+
================
3+
4+
.. automodule:: csbot.cli
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.config.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
csbot.config module
2+
===================
3+
4+
.. automodule:: csbot.config
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.core.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.core module
22
=================
33

44
.. automodule:: csbot.core
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.events.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.events module
22
===================
33

44
.. automodule:: csbot.events
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.irc.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.irc module
22
================
33

44
.. automodule:: csbot.irc
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugin.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugin module
22
===================
33

44
.. automodule:: csbot.plugin
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.auth.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.auth module
22
=========================
33

44
.. automodule:: csbot.plugins.auth
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.calc.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.calc module
22
=========================
33

44
.. automodule:: csbot.plugins.calc
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.cron.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.cron module
22
=========================
33

44
.. automodule:: csbot.plugins.cron
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.csyork.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.csyork module
22
===========================
33

44
.. automodule:: csbot.plugins.csyork
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.github.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.github module
22
===========================
33

44
.. automodule:: csbot.plugins.github
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.helix.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.helix module
22
==========================
33

44
.. automodule:: csbot.plugins.helix
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.hoogle.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.hoogle module
22
===========================
33

44
.. automodule:: csbot.plugins.hoogle
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.imgur.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.imgur module
22
==========================
33

44
.. automodule:: csbot.plugins.imgur
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.last.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.last module
22
=========================
33

44
.. automodule:: csbot.plugins.last
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.linkinfo.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.linkinfo module
22
=============================
33

44
.. automodule:: csbot.plugins.linkinfo
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.logger.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.logger module
22
===========================
33

44
.. automodule:: csbot.plugins.logger
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.mongodb.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.mongodb module
22
============================
33

44
.. automodule:: csbot.plugins.mongodb
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.rst

Lines changed: 4 additions & 3 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
@@ -31,6 +32,6 @@ Module contents
3132
---------------
3233

3334
.. automodule:: csbot.plugins
34-
:members:
35-
:undoc-members:
36-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎doc/api/csbot.plugins.termdates.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.termdates module
22
==============================
33

44
.. automodule:: csbot.plugins.termdates
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.topic.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.topic module
22
==========================
33

44
.. automodule:: csbot.plugins.topic
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.usertrack.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.usertrack module
22
==============================
33

44
.. automodule:: csbot.plugins.usertrack
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.webhook.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.webhook module
22
============================
33

44
.. automodule:: csbot.plugins.webhook
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.webserver.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.webserver module
22
==============================
33

44
.. automodule:: csbot.plugins.webserver
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.whois.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.whois module
22
==========================
33

44
.. automodule:: csbot.plugins.whois
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.xkcd.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.xkcd module
22
=========================
33

44
.. automodule:: csbot.plugins.xkcd
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.plugins.youtube.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.plugins.youtube module
22
============================
33

44
.. automodule:: csbot.plugins.youtube
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/csbot.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,18 @@ Subpackages
55
-----------
66

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

9-
csbot.plugins
10+
csbot.plugins
1011

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

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

18+
csbot.cli
19+
csbot.config
1620
csbot.core
1721
csbot.events
1822
csbot.irc
@@ -23,6 +27,6 @@ Module contents
2327
---------------
2428

2529
.. automodule:: csbot
26-
:members:
27-
:undoc-members:
28-
:show-inheritance:
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:

‎doc/api/csbot.util.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ csbot.util module
22
=================
33

44
.. automodule:: csbot.util
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,14 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
28+
extensions = [
29+
'sphinx.ext.autodoc',
30+
'sphinx.ext.intersphinx',
31+
'sphinx.ext.todo',
32+
'sphinx.ext.coverage',
33+
'sphinx.ext.viewcode',
34+
'sphinx_rtd_theme',
35+
]
2936

3037
# Add any paths that contain templates here, relative to this directory.
3138
templates_path = ['_templates']
@@ -91,7 +98,7 @@
9198

9299
# The theme to use for HTML and HTML Help pages. See the documentation for
93100
# a list of builtin themes.
94-
html_theme = 'default'
101+
html_theme = 'sphinx_rtd_theme'
95102

96103
# Theme options are theme-specific and customize the look and feel of a theme
97104
# further. For a list of options available for each theme, see the

‎doc/regen_apidoc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/bash
22
rm -rf api
3-
exec sphinx-apidoc --separate --output-dir=api/ ../csbot ../csbot/test ../csbot/test_broken ../csbot/plugins_broken
3+
exec sphinx-apidoc --separate --output-dir=api/ ../src/csbot ../src/plugins_broken

‎requirements.docs.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
-r requirements.txt
2+
sphinx
3+
sphinx_rtd_theme

‎setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,21 @@
1515
],
1616
install_requires=[
1717
'click>=6.2,<7.0',
18-
'straight.plugin==1.4.0-post-1',
1918
'pymongo>=4.0.1',
2019
'requests>=2.9.1,<3.0.0',
2120
'lxml>=2.3.5',
2221
'aiogoogle>=0.1.13',
2322
'isodate>=0.5.1',
2423
'aiohttp>=3.5.1,<4.0',
2524
'async_generator',
26-
'attrs',
25+
'attrs>=19.1,<20',
2726
'toml',
2827
'schematics',
2928
'rollbar',
3029
],
3130
entry_points={
3231
'console_scripts': [
33-
'csbot = csbot:main',
32+
'csbot = csbot.cli:main',
3433
'csbot_util = csbot.cli:util',
3534
],
3635
},

0 commit comments

Comments
 (0)