Documentation: Enhance the Release Notes by adding dropdown menus #2076
Labels
component: documentation
Documentation issue
priority: low
Low Priority
requestor: METplus Team
METplus Development Team
type: task
An actionable item of work
Milestone
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:
add 'sphinx_design' to the "extensions =" section. (note the underscore.)
add 'sphinx-design==0.3.0' with a dash
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
Labels
Projects and Milestone
Define Related Issue(s)
Consider the impact to the other METplus components.
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: