Doc errors, missing #1300

Closed
josef-pkt opened this Issue Jan 8, 2014 · 9 comments

Projects

None yet

3 participants

@josef-pkt
Member

There are a few problems in the updated docs on sourceforge

GMM docstrings still need work, cleanup and improvements

robust cov look reasonable http://statsmodels.sourceforge.net/devel/generated/statsmodels.regression.linear_model.RegressionResults.get_robustcov_results.html

I didn't check any other recent changes.

@jseabold
Member
jseabold commented Jan 8, 2014

Is it a doc build issue or a docs issue? Just checking because I just turned this machine back on after a long wait for parts.

@josef-pkt
Member

I got the message that you did it, so I started to check.

Is it a doc build issue or a docs issue?

Often it was a combination of the two when something didn't build correctly.
I don't have these problems in my local doc build. Both GEE, and gmm.LinearIVGMM are built in my html docs.
Overall, the docstrings are not completely clean. I didn't get rid of all warnings in my last round of changes.
I'm using sphinx 1.2

Was this a one-time doc build and upload, or is your machine updating (ir)regularly again?

I can do more work on the documentation, to check that recent addition and changes are correct in there.

@jseabold
Member
jseabold commented Jan 8, 2014

It's updating irregularly again. I discovered how much less my electricity bill was when I didn't leave this box on, so my long-term plan is to add the build capabilities to the windows box or to get rtcwake going. Some day...

@jseabold
Member
jseabold commented Jan 8, 2014

The GEE release notes (or any other new models) are also pretty sparse. Would be nice to have a blurb and some example code.

@ccsv
ccsv commented Jan 9, 2014

This is minor but Engle is spelled wrong on "Enlge’s Test for Autoregressive Conditional Heteroscedasticity (ARCH)" to test for ARCH effects in the documentation too.

@jseabold
Member

The GEE docs aren't being included because there is no gee.rst.

@josef-pkt
Member

good catch, silly me never committed the gee.rst file. I have it locally as an untracked file.

coming up later today

@josef-pkt josef-pkt added a commit to josef-pkt/statsmodels that referenced this issue Sep 21, 2014
@josef-pkt josef-pkt DOC add gee.rst closes see #1300 389c912
@josef-pkt
Member

LinearIVGMM is now in the GMM TOC http://statsmodels.sourceforge.net/devel/gmm.html#module-reference
maybe it was just a caching issue

@josef-pkt josef-pkt added a commit to josef-pkt/statsmodels that referenced this issue Sep 21, 2014
@josef-pkt josef-pkt DOC add gee.rst closes see #1300 fda1154
@jseabold
Member

Closing. Open another issue to improve GMM docs if you want or better yet a PR ;)

@jseabold jseabold closed this Sep 26, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment