Skip to content

Commit

Permalink
add doc dependencies + fix a few warnings
Browse files Browse the repository at this point in the history
- setuptools is needed for pkg_resources
- pickleshare is needed for the ipython extension
  • Loading branch information
saimn committed Nov 20, 2024
1 parent e84713f commit 216aaf3
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@

intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
'matplotlib': ('https://matplotlib.org/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
'matplotlib': ('https://matplotlib.org/stable/', None),
'astropy': ('https://docs.astropy.org/en/stable/', None)
}

Expand Down
6 changes: 3 additions & 3 deletions doc/objformat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,19 +111,19 @@ demonstrated below:
In [4]: plt.figure()

@savefig ObjFormatIma1.png width=2.3in
In [5]: ima1.plot(colorbar='v', title = '$\lambda$ = %.1f (%s)' %(cube.wave.coord(1000), cube.wave.unit))
In [5]: ima1.plot(colorbar='v', title = r'$\lambda$ = %.1f (%s)' %(cube.wave.coord(1000), cube.wave.unit))

In [6]: ima2 = cube[3000, :, :]

In [7]: plt.figure()

@savefig ObjFormatIma2.png width=2.3in
In [8]: ima2.plot(colorbar='v', title = '$\lambda$ = %.1f (%s)' %(cube.wave.coord(3000), cube.wave.unit))
In [8]: ima2.plot(colorbar='v', title = r'$\lambda$ = %.1f (%s)' %(cube.wave.coord(3000), cube.wave.unit))

In [7]: plt.figure()

@savefig ObjFormatZommIma2.png width=2.3in
In [8]: ima2[5:25, 15:35].plot(colorbar='v',title = 'Zoom $\lambda$ = %.1f (%s)' %(cube.wave.coord(3000), cube.wave.unit))
In [8]: ima2[5:25, 15:35].plot(colorbar='v',title = r'Zoom $\lambda$ = %.1f (%s)' %(cube.wave.coord(3000), cube.wave.unit))

In the Image objects extracted from the cube, `Image[p1:p2,q1:q2]
<mpdaf.obj.Image.__getitem__>` returns a sub-image, `Image[p,q]
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ def options(*packages, **kw):
'all': ['numexpr', 'fitsio', 'adjustText', 'joblib', 'tqdm',
'specutils'],
'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_automodapi',
'numpydoc', 'ipython', 'psutil','specutils'],
'numpydoc', 'ipython', 'psutil','specutils',
'pickleshare', 'setuptools'],
},
tests_require=['pytest'],
package_dir={'': 'lib'},
Expand Down

0 comments on commit 216aaf3

Please sign in to comment.