search

NOAA-PSL / land-offline_workflow

Creative Commons Zero v1.0 Universal
1 stars 9 forks source link

Build automatic Land DA documentation #22

Closed rhaesung closed 1 year ago

rhaesung commented 1 year ago

PR Instructions:

  1. Provide details under all.
  2. Assign Clara and one other person as reviewers.
  3. If the PR is not ready for merging, add the "DRAFT/DO NOT MERGE" label.
  4. When a PR is ready to merge, remove the "DRAFT/DO NOT MERGE" and email Clara.
  5. Before requesting that the PR be merged, complete the checklist below.

Notes on preparing PR, using git can be found in README_git

Describe your changes

Summarise all code changes included in PR:

  1. Enable automatic Land DA documentation build option with GitHub action workflow.
  2. Github action builds Sphinx documentation.
  3. Chapter 1 rst file is added.

List any associated PRs in the submodules.

Issue ticket number and link

List the git Issue that this PR addresses:

Test output

Is this PR expected to pass the DA_IMS_test (ie., does it change the output)?

Does it pass the DA_IMS_test?

If changes to the test results are expected, what are these changes? Provide a link to the output directory when running the test:

Checklist before requesting a review

jkbk2004 commented 1 year ago

@rhaesung can you attach pdf file to this conversation that you might generate with rst? it might be hard to read rst file.

jkbk2004 commented 1 year ago

@rhaesung can you add Gillian's permission to your fork branch? so that she can directly edit.

rhaesung commented 1 year ago

@rhaesung can you attach pdf file to this conversation that you might generate with rst? it might be hard to read rst file.

The RST file looks fine now. Let me know if you still have difficulty reading it. https://github.com/rhaesung/land-offline_workflow/blob/feature/docs/docs/source/Introduction_v0.rst

rhaesung commented 1 year ago

@rhaesung can you add Gillian's permission to your fork branch? so that she can directly edit.

Added Gillian as a collaborator.

jkbk2004 commented 1 year ago

@rhaesung I am closing this draft pr since all doc build features were added ok to v1 release.