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

Documentation: Make Headers Consistent in METcalcpy User's Guides #313

Closed
6 of 7 tasks
jprestop opened this issue Jul 6, 2023 · 2 comments · Fixed by #316 or #336
Closed
6 of 7 tasks

Documentation: Make Headers Consistent in METcalcpy User's Guides #313

jprestop opened this issue Jul 6, 2023 · 2 comments · Fixed by #316 or #336
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: sub-issue Break an issue down into smaller parts

Comments

@jprestop
Copy link
Collaborator

jprestop commented Jul 6, 2023

This is a sub-issue of METplus: Documentation: Make Headers Consistent in METplus components User's Guides #898.

Describe the Sub-Issue

This task is for all METplus component. This specific issue is for METcalcpy only:

The headers for the METplus components User's Guides may not be consistent, but we want them to be.

Here is the syntax from the RST docs (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections):

# with overline, for parts (e.g. the RTD documentation for the component (i.e. docs/index.rst), each guide (e.g. User's Guide, Contributor's Guide) (i.e. docs/Users_Guide/index.rst, docs/Contributors_Guide/index.rst))
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Time Estimate

1 to 3 days of work

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions
@jprestop jprestop added component: documentation Documentation issue priority: medium Medium Priority type: sub-issue Break an issue down into smaller parts requestor: METplus Team METplus Development Team labels Jul 6, 2023
@jprestop jprestop added this to the METcalcpy 2.1.0 milestone Jul 6, 2023
@jprestop jprestop moved this from 📋 Backlog to 🏗 In progress in METplus-Analysis-5.1.0 Development Jul 6, 2023
@lisagoodrich
Copy link
Contributor

@jprestop I added ### for the titles in the index.rst files to match the "parts" formatting. Then I thought I was supposed to take the bolded titles and turn them into chapters. If I do this, I mess up the Table of Contents (TOC). I'm pretty sure the chapter change is the problem. I'll wait to discuss this before creating a pull request.

@lisagoodrich lisagoodrich linked a pull request Jul 17, 2023 that will close this issue
13 tasks
@lisagoodrich lisagoodrich moved this from 🏗 In progress to 👀 In review in METplus-Analysis-5.1.0 Development Jul 17, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in METplus-Analysis-5.1.0 Development Jul 24, 2023
@lisagoodrich
Copy link
Contributor

The develop/docs/index.rst file was missed in the original pull request. The headers need to be changed to = instead of #

@lisagoodrich lisagoodrich reopened this Nov 10, 2023
@lisagoodrich lisagoodrich linked a pull request Nov 10, 2023 that will close this issue
13 tasks
@jprestop jprestop moved this to 👀 In review in METplus-Analysis-6.0.0 Development Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: sub-issue Break an issue down into smaller parts
Projects
Status: 🔎 In review
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants