Get auth docs building

[cbanek]

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.

[cbanek]

So here's the build error that has me perplexed:

/home/travis/build/astropy/pyvo/docs/auth/index.rst.rst:19:autosummary: stub file not found 'pyvo.auth.authsession.AuthURLs'. Check your autosummary_generate setting.
Sphinx Documentation subprocess failed with return code 2

So, it should be pyvo.auth.authurls.AuthURLs is the python import path for that module, not authsession. I'm not sure where it's getting this path or how it is generating it, but obviously I am doing something wrong here.

[jonathansick]

Hey @cbanek ! At the top of authsession.py, add this:

__all__ = ('AuthSession',)

What's going on is that automodapi thingk AuthURLs and CredentialStore are defined in authsession.py because they're imported into the namespace for that module. Using the __all__ curates that namespace to just the stuff that the authsession module itself defines.

You might also want to import AuthSession, AuthURLs, and CredentialStore into the __init__.py of pyvo.auth and then have one automodapi directive pointing at that namespace — but that's an API design decision.

[codecov]

Codecov Report

Merging #194 into master will increase coverage by 0.05%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #194      +/-   ##
==========================================
+ Coverage   70.81%   70.86%   +0.05%     
==========================================
  Files          37       38       +1     
  Lines        3906     3913       +7     
==========================================
+ Hits         2766     2773       +7     
  Misses       1140     1140

Impacted Files	Coverage Δ
pyvo/auth/__init__.py	100% <100%> (ø)
pyvo/auth/credentialstore.py	92.1% <100%> (+0.21%)	⬆️
pyvo/auth/authurls.py	80.85% <100%> (+0.41%)	⬆️
pyvo/auth/authsession.py	92.3% <100%> (+0.3%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 33f64f9...2040f78. Read the comment docs.

[funbaker]

Formally ok, just a small remark: examples are still missing.

[andamian]

@cbanek Merged this - finally. Sorry for the delay.