Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Clean up the documentation in several places #893

Merged
merged 5 commits into from
Sep 21, 2022

Conversation

xylar
Copy link
Collaborator

@xylar xylar commented Sep 21, 2022

  • Reorganize the documentation to be more like compass
  • Exclude the template from the design documents in the documentation
  • Make the path to AnalysisTask simpler in the API (which makes is easier to reference elsewhere in the docs)
  • Add missing API for several methods of RemapMpasClimatologySubtask
  • Fix incorrectly formatted docstrings in RemapMpasClimatologySubtask

@xylar xylar self-assigned this Sep 21, 2022
@xylar xylar added the clean up label Sep 21, 2022
@xylar
Copy link
Collaborator Author

xylar commented Sep 21, 2022

Testing

I build the documentation locally with this branch and it looks fine (though it's hard to be 100% sure with so many changes) and builds without errors.

@xylar xylar merged commit dc04513 into MPAS-Dev:develop Sep 21, 2022
@xylar xylar deleted the clean_up_docs branch September 21, 2022 02:12
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant