diff options
Diffstat (limited to 'sites')
| -rw-r--r-- | sites/docs/api.rst | 8 | ||||
| -rw-r--r-- | sites/docs/conf.py | 3 | ||||
| -rw-r--r-- | sites/docs/index.rst | 3 |
3 files changed, 14 insertions, 0 deletions
diff --git a/sites/docs/api.rst b/sites/docs/api.rst new file mode 100644 index 00000000..47615709 --- /dev/null +++ b/sites/docs/api.rst @@ -0,0 +1,8 @@ +.. _api: + +API +=== + +.. automodule:: paramiko + :members: + :special-members: diff --git a/sites/docs/conf.py b/sites/docs/conf.py index 0c7ffe55..94267f0a 100644 --- a/sites/docs/conf.py +++ b/sites/docs/conf.py @@ -1,4 +1,7 @@ # Obtain shared config values import os, sys sys.path.append(os.path.abspath('..')) +sys.path.append(os.path.abspath('../..')) from shared_conf import * + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] diff --git a/sites/docs/index.rst b/sites/docs/index.rst index 08b34320..7ec5825e 100644 --- a/sites/docs/index.rst +++ b/sites/docs/index.rst @@ -4,3 +4,6 @@ Welcome to Paramiko's documentation! This site covers Paramiko's usage & API documentation. For basic info on what Paramiko is, including its public changelog & how the project is maintained, please see `the main website <http://paramiko.org>`_. + +.. toctree:: + api |