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

Refresh documentation #4

Closed
15 tasks done
mperrin opened this issue Jun 25, 2012 · 6 comments
Closed
15 tasks done

Refresh documentation #4

mperrin opened this issue Jun 25, 2012 · 6 comments
Milestone

Comments

@mperrin
Copy link
Owner

mperrin commented Jun 25, 2012

Documentation issues checklist

  • Remove commented text from webbpsf.rst (and elsewhere)
  • Mention :py:attr:JWInstrument.options where appropriate in webbpsf.rst Instrument options keyword argument doesn't validate option names #24
  • Update instrument subclassing example (refers to webbpsf.TFI, ThinLens without radius)
  • Move poppy.rst into POPPY (if there's information there that isn't already in the POPPY docs). Should leave just enough discussion in webbpsf docs to explain at a high level what POPPY is and how it is used in WebbPSF, just so that WebbPSF users can have some technical sense of how it works under the hood without having to jump to the full POPPY documentation.
  • Change the module index to link directly to the webbpsf module page
  • Remove all mention of Python 2.6.x support Remove all mention of Python 2.6.x support #27
  • Explain (or explain in POPPY docs and link to) how to set use_multiprocessing Docs: "Performance and Parallelization" appendix out of date #23
  • Set up intersphinx for references to POPPY
  • Link to poppy.Instrument options attribute docs from JWInstrument (depends on intersphinx?)
  • Add documentation for image jitter options to WebbPSF docs.
  • Add documentation for package level configuration settings
  • ttk interface screenshots look worse than the ttk interface actually does these days... time to update them
  • Figure out why some :py:meth:'foo' style links (with backticks) won't resolve
  • anything to improve for logging functionality docs?
  • how to output intermediate step images
@mperrin
Copy link
Owner Author

mperrin commented Jun 25, 2012

document output mode that only saves the downsampled image, etc.

@mperrin
Copy link
Owner Author

mperrin commented Sep 13, 2013

Need to document new configuration settings system.

mperrin pushed a commit that referenced this issue May 19, 2014
Use bootstrap-astropy theme in docs
@mperrin mperrin added this to the 0.3 milestone Sep 3, 2014
@mperrin
Copy link
Owner Author

mperrin commented Sep 3, 2014

Much progress in recent commits.

@josePhoenix
Copy link
Collaborator

@mperrin: Which of the things you mentioned above are still outstanding, if any? Feel free to edit this checklist.

Moved checklist to initial comment so the progress bar will show up on the issues list page.

@mperrin
Copy link
Owner Author

mperrin commented Nov 25, 2014

Some updates added. Thanks for organizing this.

@mperrin
Copy link
Owner Author

mperrin commented Jan 21, 2015

Closed via pull request #33

Thanks for all your efforts cleaning up all these details and generally polishing the presentation - much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants