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: Enhance the Release Notes by adding dropdown menus #2076

Closed
8 of 20 tasks
lisagoodrich opened this issue Mar 3, 2023 · 0 comments · Fixed by #2083
Closed
8 of 20 tasks

Documentation: Enhance the Release Notes by adding dropdown menus #2076

lisagoodrich opened this issue Mar 3, 2023 · 0 comments · Fixed by #2083
Assignees
Labels
component: documentation Documentation issue priority: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@lisagoodrich
Copy link
Contributor

lisagoodrich commented Mar 3, 2023

Please use Sphinx Design for Dropdown menus . This will allow for searches of material hidden within dropdown menus.

Changes will need to be made to the below files:

  1. config.py
    add 'sphinx_design' to the "extensions =" section. (note the underscore.)
  2. requirements.txt file.
    add 'sphinx-design==0.3.0' with a dash
  3. METplus/.github/workflows/documentation.yml
    add a line after this example line 28 . Make sure it is correctly indented.
    python -m pip install -r docs/requirements.txt

It should look like this:
python -m pip install --upgrade sphinx sphinx-gallery sphinx_rtd_theme
python -m pip install python-dateutil requests Pillow
python -m pip install -r docs/requirements.txt

Panel drop downs would be added for the subcategories and sub-subcategories. For example,
-Repository and build
---Installation
---Static Code Analysis
---Testing
---Continuous Integration
-Documentation
-Library code
---Bugfixes
---Python embedding enhancements
---Miscellaneous
---NetCDF Library
---Statistics computations
etc.

Describe the Task

Provide a description of the task here.

Time Estimate

less than a day

Sub-Issues

None

Relevant Deadlines

NONE.

Funding Source

Split between accounts 2702691 and 2792542.

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 PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.- [ ] Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@lisagoodrich lisagoodrich added component: documentation Documentation issue priority: low Low Priority type: task An actionable item of work requestor: METplus Team METplus Development Team labels Mar 3, 2023
@lisagoodrich lisagoodrich added this to the METplus-5.1.0 milestone Mar 3, 2023
@lisagoodrich lisagoodrich self-assigned this Mar 3, 2023
@lisagoodrich lisagoodrich linked a pull request Mar 13, 2023 that will close this issue
14 tasks
@georgemccabe georgemccabe changed the title Enhance the Release Notes by adding dropdown menus Documentation: Enhance the Release Notes by adding dropdown menus Apr 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: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant