Skip to content

Commit

Permalink
Adds note to api.rst
Browse files Browse the repository at this point in the history
i did this with github's web-editor. i haven't checked what's rendered.
  • Loading branch information
funkyfuture committed Sep 20, 2015
1 parent 6c08c00 commit 4dd0510
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/api.rst
Expand Up @@ -2,6 +2,10 @@
API
===

.. important::
The documented methods' signatures are not always correct.
See :class:`path.Path`.

.. automodule:: path
:members:
:undoc-members:
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -10,7 +10,7 @@
version = re.match('[^.]+[.][^.]+', release).group(0)

pygments_style = 'sphinx'
html_theme = 'default'
html_theme = 'alabaster'
html_static_path = ['_static']
htmlhelp_basename = 'pathpydoc'
templates_path = ['_templates']
Expand Down

0 comments on commit 4dd0510

Please sign in to comment.