New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
AGG link changed. Also fix other doc warnings #3342
Conversation
I just noticed that lines.py and patches.py weren't included in the API listing. Seems odd to leave out two of the 4 drawing primitives from the API list. I think their docs were still getting generated elsewhere, just not included in this TOC. |
And also just noticed that "text" was also not included in the API list... that is 3 out of 4 artist primitives that were not listed here until now. |
I looked at doing the same thing with the line and company rst files a while ago, but decided against it as they are already included in |
So, do you want me to back out the three additional links, or do we want to On Wed, Aug 6, 2014 at 10:37 AM, Thomas A Caswell notifications@github.com
|
I think removing the api doc in artists is the right thing to do, but have erred on the side of minimal changes in the past. That said I don't have a strong view except that it should not be in both places |
Ok, I went with a "flat is better than nested approach". On Wed, Aug 6, 2014 at 6:44 PM, Thomas A Caswell notifications@github.com
|
DOC : fixed links, un-nested artist API docs AGG link changed. Also fix other doc warnings
Here are some of the remaining warnings I see (I have a total of 77):
I am also seeing that some rst files are not getting included into the TOC. In particular, the patheffects guide.
One thing to remember with sphinx is that it only emits warnings and errors for files that it is updating. So one must remember to do a fresh doc build from time to time to catch things that have gone out of date or were broken, but never fixed.