Skip to content

Commit

Permalink
Get auth docs building (#194)
Browse files Browse the repository at this point in the history
* Get auth docs building

For some reason, the docstrings for the auth classes aren't
being built into the docs.  Add a link from the main page to
get things generated.
  • Loading branch information
cbanek authored May 5, 2020
1 parent 1cda55a commit 1935280
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/auth/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
******************
Auth (`pyvo.auth`)
******************
This module contains submodules which help handle auth when
communicating with virtual observatory services.

Reference/API
=============

.. automodapi:: pyvo.auth

.. automodapi:: pyvo.auth.authsession

.. automodapi:: pyvo.auth.authurls

.. automodapi:: pyvo.auth.credentialstore
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,4 @@ Using `pyvo`
dal/index
registry/index
io/index
auth/index
6 changes: 6 additions & 0 deletions pyvo/auth/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst

__all__ = ["AuthSession", "AuthURLs", "CredentialStore"]

from .authsession import AuthSession
from .authurls import AuthURLs
from .credentialstore import CredentialStore
2 changes: 2 additions & 0 deletions pyvo/auth/authsession.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
from .authurls import AuthURLs
from .credentialstore import CredentialStore

__all__ = ["AuthSession"]


class AuthSession:
"""
Expand Down
2 changes: 2 additions & 0 deletions pyvo/auth/authurls.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

from . import securitymethods

__all__ = ["AuthURLs"]


class AuthURLs():
"""
Expand Down
2 changes: 2 additions & 0 deletions pyvo/auth/credentialstore.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

from . import securitymethods

__all__ = ["CredentialStore"]


class CredentialStore(object):
"""
Expand Down

0 comments on commit 1935280

Please sign in to comment.