Skip to content

Source code does not display too well #13

@drphilmarshall

Description

@drphilmarshall

Check out the example as displayed by sphinx:

http://www.slac.stanford.edu/~pjm/ImageSimulationRecipes/doc/build/html/_modules/recipes/stargal.html#stargal

Some suggestions for making this more readable/attractive:

  • Keep lines to 72 (?) characters long!
  • Format header to be better-parsed by sphinx
  • Change the background color in the conf.py file to match the rest of the theme
  • Maybe use docstrings throughout script to explain the use of various utensils? (Later)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions