Skip to content

Commit

Permalink
doc tests
Browse files Browse the repository at this point in the history
  • Loading branch information
fp12 committed Jan 1, 2017
1 parent 8ddb212 commit 11819a8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,31 @@ Tournament

.. autoclass:: challonge.Tournament
:members:
:member-order: bysource


Participant
-----------

.. autoclass:: challonge.Participant
:members:
:member-order: bysource


Match
-----

.. autoclass:: challonge.Match
:members:
:member-order: bysource


Attachment
----------

.. autoclass:: challonge.Attachment
:members:
:member-order: bysource


Exception
Expand Down
9 changes: 6 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,17 @@
#
import os
import sys


sys.path.insert(0, os.path.abspath('..'))


on_rtd = os.getenv('READTHEDOCS') == 'True'


autodoc_member_order = 'bysource'


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand All @@ -50,7 +56,6 @@
.. |from_api| replace:: *From Challonge API*:
"""


# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
Expand Down Expand Up @@ -81,8 +86,6 @@
# Usually you set "language" from the command line for these cases.
language = None

autodoc_member_order = 'bysource'


# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down

0 comments on commit 11819a8

Please sign in to comment.