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

Making simple sample python codes with embedded docstrings for sphinx to process

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Templates:
    • Story Points:
      1
    • Epic Link:
    • Sprint:
      DRP S17-1, DRP S17-2
    • Team:
      Data Release Production

      Description

      To learn how the sphinx framework works with the actual code, will make some simple examples of python code with docstrings, then in an rst file, place a directive to process that piece of code, and make a nice finally processed html page from it.

        Attachments

          Container Issues

            Issue Links

              Activity

                People

                • Assignee:
                  mssgill Mandeep Gill [X] (Inactive)
                  Reporter:
                  mssgill Mandeep Gill [X] (Inactive)
                  Reviewers:
                  John Swinbank
                  Watchers:
                  John Swinbank, Mandeep Gill [X] (Inactive)
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel