[3.1] Remote access when building documentation

For the Debian astropy package, I also build a (separate) documentation package, python-astropy-doc with python3 setup.py build_docs.
With version 3.1, it however starts to require some internet access to do so:

astropy/examples/coordinates/plot_obs-planning.py

Line 59 in 743055c

m33 = SkyCoord.from_name('M33')

requires external catalog access

astropy/examples/io/modify-fits-header.py

Line 27 in 743055c

fits_file = get_pkg_data_filename('tutorials/FITS-Header/input_file.fits')

astropy/examples/io/fits-tables.py

Line 37 in 743055c

    
           event_filename = get_pkg_data_filename('tutorials/FITS-tables/chandra_events.fits')

astropy/examples/io/plot_fits-image.py

Line 35 in 743055c

image_file = get_pkg_data_filename('tutorials/FITS-images/HorseHead.fits')

require download of a small FITS file.

The downloads in these cases seems to be not really necessary (they could be provided locally, as others already are). This would make the documentation self-contained.

@eteq

There was a suggestion by @eteq to revamp the examples gallery over at #7242 . In the meantime, from what I see here,

astropy/docs/conf.py

Lines 224 to 246 in 9bffef1

    
           try: 
        
               import sphinx_gallery 
        
               extensions += ["sphinx_gallery.gen_gallery"] 
        
               sphinx_gallery_conf = { 
        
                   'backreferences_dir': 'generated/modules', # path to store the module using example template 
        
                   'filename_pattern': '^((?!skip_).)*$', # execute all examples except those that start with "skip_" 
        
                   'examples_dirs': '..{}examples'.format(os.sep), # path to the examples scripts 
        
                   'gallery_dirs': 'generated/examples', # path to save gallery generated examples 
        
                   'reference_url': { 
        
                       'astropy': None, 
        
                       'matplotlib': 'http://matplotlib.org/', 
        
                       'numpy': 'http://docs.scipy.org/doc/numpy/', 
        
                   }, 
        
                   'abort_on_example_error': True 
        
               } 
        
           except ImportError: 
        
               def setup(app): 
        
                   app.warn('The sphinx_gallery extension is not installed, so the ' 
        
                            'gallery will not be built.  You will probably see ' 
        
                            'additional warnings about undefined references due ' 
        
                            'to this.')

perhaps by uninstalling sphinx-gallery, you can "hack" the doc build to not build the "examples" directory?

In the Debian build, I just removed the examples in question, so no hurry is needed. It was more to keep the docs somehow clean, not knowing about #7242.

Navigation Menu

Repository navigation

[3.1] Remote access when building documentation #8311

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	try:
	import sphinx_gallery
	extensions += ["sphinx_gallery.gen_gallery"]

	sphinx_gallery_conf = {
	'backreferences_dir': 'generated/modules', # path to store the module using example template
	'filename_pattern': '^((?!skip_).)*$', # execute all examples except those that start with "skip_"
	'examples_dirs': '..{}examples'.format(os.sep), # path to the examples scripts
	'gallery_dirs': 'generated/examples', # path to save gallery generated examples
	'reference_url': {
	'astropy': None,
	'matplotlib': 'http://matplotlib.org/',
	'numpy': 'http://docs.scipy.org/doc/numpy/',
	},
	'abort_on_example_error': True
	}

	except ImportError:
	def setup(app):
	app.warn('The sphinx_gallery extension is not installed, so the '
	'gallery will not be built. You will probably see '
	'additional warnings about undefined references due '
	'to this.')

[3.1] Remote access when building documentation #8311

Description

Activity

pllim commented on Dec 31, 2018

olebole commented on Dec 31, 2018

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions