Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-4002

Add doc dir and main.dox to obs_test

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: obs_test
    • Labels:
      None

      Description

      No obs_* packages have a doc dir. I suggest starting with obs_test since it is perhaps less obvious what it is used for than the others and in some ways acts as a template.

        Attachments

          Issue Links

            Activity

            Hide
            rowen Russell Owen added a comment -

            If you have a moment, please take a quick look.

            Show
            rowen Russell Owen added a comment - If you have a moment, please take a quick look.
            Hide
            rowen Russell Owen added a comment - - edited

            In case it helps, I am temporarily serving the documentation that my Mac generated for obs_test at the following location: http://www.astro.washington.edu/users/rowen/temp/html/

            The main page (index.html) is the one generated by the new main.dox file.

            Show
            rowen Russell Owen added a comment - - edited In case it helps, I am temporarily serving the documentation that my Mac generated for obs_test at the following location: http://www.astro.washington.edu/users/rowen/temp/html/ The main page (index.html) is the one generated by the new main.dox file.
            Hide
            sullivan Ian Sullivan added a comment -

            I've added a few comments on Github. Please let me know if those are not visible to you.

            Show
            sullivan Ian Sullivan added a comment - I've added a few comments on Github. Please let me know if those are not visible to you.
            Hide
            rowen Russell Owen added a comment - - edited

            Thank you, Ian. I made most of the changes you requested and removed a bit of information from data/ReadMe.md that was duplicated in the new doc/main.dox file. I also added an example showing how to get a butler, camera geometry and raw image.

            Show
            rowen Russell Owen added a comment - - edited Thank you, Ian. I made most of the changes you requested and removed a bit of information from data/ReadMe.md that was duplicated in the new doc/main.dox file. I also added an example showing how to get a butler, camera geometry and raw image.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              Ian Sullivan
              Watchers:
              Ian Sullivan, Kian-Tat Lim, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.