Skip to content

Commit

Permalink
docs: Majorly overhaul organization and format
Browse files Browse the repository at this point in the history
  • Loading branch information
embolalia committed Jan 16, 2016
1 parent b567c72 commit 9b250d7
Show file tree
Hide file tree
Showing 13 changed files with 192 additions and 430 deletions.
45 changes: 45 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Additional API features
=======================

Sopel includes a number of additional functions that are useful for various
common IRC tasks.

Note that ``sopel.web`` was deprecated in 6.2.0, and is not included in this
documentation, but is still in use in many modules. It's highly recommended
that you switch to `requests <http://docs.python-requests.org/en/latest/>`_
instead.

.. contents::

sopel.tools
------------

.. automodule:: sopel.tools
:members:

sopel.tools.time
----------------
.. automodule:: sopel.tools.time
:members:

sopel.tools.calculation
-----------------------
.. automodule:: sopel.tools.calculation
:members:

sopel.tools.target
------------------
.. automodule:: sopel.tools.target
:members:

sopel.tools.events
------------------
.. autoclass:: sopel.tools.events
:members:
:undoc-members:

sopel.formatting
-----------------
.. automodule:: sopel.formatting
:members:
:undoc-members:
3 changes: 2 additions & 1 deletion docs/source/bot.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. title:: The bot and its state
The bot and its state
=====================

.. autoclass:: sopel.bot.Sopel
:members:
Expand Down
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
20 changes: 20 additions & 0 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Configuration functionality
===========================

.. automodule:: sopel.config
:members:
:undoc-members:


.. automodule:: sopel.config.types
:members:
:undoc-members:

The [core] configuration section
--------------------------------

.. autoclass:: sopel.config.core_section.CoreSection
:members:
:undoc-members:


5 changes: 5 additions & 0 deletions docs/source/db.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The bot's database
==================

.. automodule:: sopel.db
:members:
Loading

0 comments on commit 9b250d7

Please sign in to comment.