GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Lots of minor changes to docs to reduce Sphinx warnings. by mdboom · Pull Request #63 · matplotlib/matplotlib

Conversation

@mdboom

@mdboom mdboom commented Mar 29, 2011

Copy link
Copy Markdown
Member

No description provided.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
mdboom and others added 4 commits March 29, 2011 08:50
@mdboom
Lots of minor changes to docs to reduce Sphinx warnings.
6b11910
@ivanov
removes sphinx xfileref_role deprecation warning
19051a9
@ivanov
catch ImportError if xlwt not installed
407f83a
@ivanov
remove ImportError if Basemap not installed
6c653e8
@ivanov

ivanov commented Mar 29, 2011

Copy link
Copy Markdown
Member

Looks good, I have 3 more that I got rid of in @ivanov:matplotlib/minor_doc_fixes (I opened a pull request on your branch, Michael)

1.

/scratch/matplotlib/doc/sphinxext/inheritance_diagram.py:312: DeprecationWarning: xfileref_role is deprecated, use XRefRole
  'class', ':class:`%s`' % name, name, 0, state)

2.

/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py:322: PlotWarning: Exception running plot /scratch/matplotlib/doc/mpl_examples/pylab_examples/loadrec.py
Traceback (most recent call last):
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 319, in render_figures
    run_code(plot_path, function_name, plot_code, context=context)
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 230, in run_code
    "__plot__", fd, fname, ('py', 'r', imp.PY_SOURCE))
  File "loadrec.py", line 17, in 
  File "/home/pi/tmp/local/lib/python2.6/site-packages/mpl_toolkits/exceltools.py", line 25, in 
    import xlwt as excel
ImportError: No module named xlwt

3.

/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py:322: PlotWarning: Exception running plot pyplots/plotmap.py
Traceback (most recent call last):
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 319, in render_figures
      run_code(plot_path, function_name, plot_code, context=context)
    File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 230, in run_code
      "__plot__", fd, fname, ('py', 'r', imp.PY_SOURCE))
    File "plotmap.py", line 1, in 
  ImportError: No module named basemap

Warnings which still remain:

Here are some warning that I did not get to the bottom of after a quick glance:

lots of WARNING: image file not readable for pylab_examples PDFs (I ran python make.py html --small)

/scratch/matplotlib/doc/mpl_examples/units/basic_units.py:119: DeprecationWarning: object.__new__() takes no parameters
  return object.__new__(cls, value, unit)
/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py:322: PlotWarning: Exception running plot /scratch/matplotlib/doc/mpl_examples/units/artist_tests.py
Traceback (most recent call last):
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 319, in render_figures
    run_code(plot_path, function_name, plot_code, context=context)
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/sphinxext/plot_directive.py", line 230, in run_code
    "__plot__", fd, fname, ('py', 'r', imp.PY_SOURCE))
  File "artist_tests.py", line 30, in 
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/collections.py", line 852, in __init__
    self.set_segments(segments)
  File "/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/collections.py", line 861, in set_segments
    seg = np.asarray(seg, np.float_)
  File "/home/pi/tmp/local/lib/python2.6/site-packages/numpy/core/numeric.py", line 284, in asarray
    return array(a, dtype, copy=False, order=order)
ValueError: setting an array element with a sequence.

/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hexbin:129: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
/home/pi/tmp/local/lib/python2.6/site-packages/matplotlib/pyplot.py:docstring of matplotlib.pyplot.annotate:13: (ERROR/3) Unexpected indentation.

also, not sure if this matters, but I'll mention it anyway:

checking consistency... /scratch/matplotlib/doc/devel/gitwash/dot2_dot3.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/examples/index.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/faq/environment_variables_faq.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/mpl_toolkits/axes_grid/index.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/mpl_toolkits/mplot3d/index.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/users/arraydata.rst:: WARNING: document isn't included in any toctree
/scratch/matplotlib/doc/users/plotting.rst:: WARNING: document isn't included in any toctree
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@mdboom

mdboom commented Mar 31, 2011

Copy link
Copy Markdown
Member Author

I'm not sure how to remove the "image file not readable" warnings. They occur because the PDFs are used to generate LaTeX (and the doctree is generated in such a way that it can output either HTML or LaTeX), but we aren't generating them when "html --small" is passed. For HTML, this is just an annoyance -- however, if the user does "html --small" and then "latex", the latex will fail. So "html --small" is a bit of a dangerous hack, but I'm not sure of the best solution.

I'm stumped by the "basic_units" example. I'm stumped by units in general in matplotlib ;)

The hexbin and annotate docstring warnings also stump me: both the input and output appear fine, so I'm not sure what docutils is complaining about.

As for the orphaned rst files, I think I'll use "git blame" to follow up with the authors of those files to determine if they should be linked up or removed.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

mdboom and others added 15 commits March 31, 2011 14:17
@mdboom
Add the toolkit documentation to the main table of contents.
2843eae
@mdboom
Reorganize old toolkits page into new toolkits index.
e468159
@mdboom
Put the installation instructions in a single file (INSTALL), and cop…
d5f183e
…y it into the Sphinx tree during the Sphinx build.
@mdboom
Remove out-of-date developer docs -- the Sphinx docs have long superc…
cb27de3
…eded them.
@mdboom
Remove out-of-date information about backend capabilities
2deb0a4
@mdboom
Remove out-of-date information about interactive prompts.
b127ac3
@mdboom
Remove out-of-date information about segfaults.
f7a3164
@mdboom
Remove out-of-date information about known bugs. This has been superc…
4972fd9
…eded by the bug tracker.
@mdboom
Note that we now require Sphinx 1.0
cbedb35
@mdboom
Update description of contents of doc directory.
8f09688
@mdboom
Update information about running tests.
7a5f3d5
@mdboom
Document the contents of the example directories.
7b24b2a
@ddale
fix a few more sphinx warnings
be14152
@mdboom
Merge branch 'plot_directive' of github.com:mdboom/matplotlib into mi…
6926044
…nor_doc_fixes

Conflicts:
	lib/matplotlib/sphinxext/plot_directive.py
@ddale
fixes a few rest formatting issues
969ddd8
@mdboom
mdboom merged commit 969ddd8 into matplotlib:master Apr 8, 2011
@richbwood richbwood mentioned this pull request Dec 19, 2012
test_pcolormesh hangs #1609
Closed
@mdboom
mdboom deleted the minor_doc_fixes branch March 3, 2015 18:44
fariza added a commit to fariza/matplotlib that referenced this pull request Sep 22, 2016
@fariza
Merge pull request matplotlib#63 from fgoudreault/parser_doc
f11b2da
parser documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@mdboom @ivanov @ddale
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.