Create dropdown menus for Appendix A #2460
Labels
component: documentation
Documentation issue
priority: medium
Medium Priority
requestor: METplus Team
METplus Development Team
type: task
An actionable item of work
Milestone
Replace italics below with details for this issue.
Describe the Task
Sphinx Design for Dropdown menus is a new way of creating dropdown menus. These menus are searchable using ctrl - f or the search function in READTHEDOCS. The old version (sphinx-panels) wasn't searchable. In order to maintain consistency and for ease of documentation viewing, change the questions and answers in Appendix A to dropdown menus.
In order to be able to link to the questions, they will need to stay as sections. Every dropdown menu should be labeled "Answer". The answer documentation will be in the dropdown menu. The question will be viewable as a section header.
Please note that changes have already been made to the config.py and the requirements.rst file. sphinx_design with an underscore needed to be added to the config.py file. And sphinx-design with a dash needed to be added to the requirements.rst file. If this is going to be done on other METplus products, this may need to be added to work.
Time Estimate
Estimate the amount of work required here.
1 to 2 days of work.
Sub-Issues
Consider breaking the task down into sub-issues.
Relevant Deadlines
List relevant project deadlines here or state NONE.
There is no hard deadline for this
Funding Source
2792541
Define the Metadata
None
Assignee
Labels
Projects and Milestone
Define Related Issue(s)
Consider the impact to the other METplus components. NO IMPACT
Task Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
Select: Reviewer(s) and Development issues
Select: Repository level development cycle Project for the next official release
Select: Milestone as the next official version
The text was updated successfully, but these errors were encountered: