Skip to content
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

Merged
merged 4 commits into from Aug 7, 2014

Conversation

WeatherGod
Copy link
Member

Here are some of the remaining warnings I see (I have a total of 77):

...14: WARNING: undefined label: mpl-color-spec (if the link has no caption the label must precede a section header)
<autosummary>:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.Triangulation.edges'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.Triangulation.neighbors'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.TriAnalyzer.scale_factors'
None:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.Triangulation.edges'
None:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.Triangulation.neighbors'
None:None: WARNING: toctree contains reference to nonexisting document u'api/matplotlib.tri.TriAnalyzer.scale_factors'
/home/ben/Programs/matplotlib/doc/users/screenshots.rst:297: WARNING: undefined label: user_interfaces-embedding_in_qt (if the link has no caption the label must precede a section header)
/home/ben/Programs/matplotlib/doc/users/whats_new.rst:79: WARNING: undefined label: ~examples/statistics/boxplot_demo.py (if the link has no caption the label must precede a section header)
/home/ben/Programs/matplotlib/doc/users/whats_new.rst:79: WARNING: undefined label: ~examples/statistics/bxp_demo.py (if the link has no caption the label must precede a section header)
/home/ben/Programs/matplotlib/doc/users/whats_new.rst:1079: WARNING: undefined label: legend-complex-plots (if the link has no caption the label must precede a section header)

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.

@WeatherGod
Copy link
Member Author

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.

@WeatherGod
Copy link
Member Author

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.

@tacaswell tacaswell added this to the v1.4.0 milestone Aug 4, 2014
@tacaswell tacaswell added the doc label Aug 4, 2014
@tacaswell
Copy link
Member

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 artists.rst, this effectively documents them twice.

@WeatherGod
Copy link
Member Author

So, do you want me to back out the three additional links, or do we want to
modify the artist api doc? Honestly, I am all for consistency, so if I
can't find an API doc for line, I am going to presume it is missing rather
than go searching in the artist doc.

On Wed, Aug 6, 2014 at 10:37 AM, Thomas A Caswell notifications@github.com
wrote:

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
artists.rst, this effectively documents them twice.


Reply to this email directly or view it on GitHub
#3342 (comment)
.

@tacaswell
Copy link
Member

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

@WeatherGod
Copy link
Member Author

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
wrote:

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


Reply to this email directly or view it on GitHub
#3342 (comment)
.

tacaswell added a commit that referenced this pull request Aug 7, 2014
DOC : fixed links, un-nested artist API docs

AGG link changed. Also fix other doc warnings
@tacaswell tacaswell merged commit 9cb3350 into matplotlib:v1.4.x Aug 7, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants