-
Notifications
You must be signed in to change notification settings - Fork 24
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
Enhance the Release Notes by adding dropdown menus #2146
Comments
@lisagoodrich and I are reopening this issue because we have one more step that needs to be completed. The build on ReadTheDocs is working fine, but the build in GitHub Actions is not. The GHA run appeared to be successful, but was actually not successful. We are already aware of this problem and it will be fixed with the issue Bugfix: Check the return status of the "make clean html" command in build_documentation.sh #2436. The following needs to be added to this issue: MET/.github/workflows/documentation.yml
It should look like this:
|
I have updated the issue information with the steps needed to make sure the dropdown menus run correctly. |
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 python-dateutil requests sphinx
sphinx-gallery Pillow sphinx_rtd_theme
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.
Note: One downside to using panels is that the content of the text contained in the panel will not show up in the search. However, I’m not sure the search functionality is particularly important for the Release Notes.
Time Estimate
Less than 1 day
Sub-Issues
Consider breaking the enhancement down into sub-issues.
Relevant Deadlines
List relevant project deadlines here or state 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.
Enhancement Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
Select: Reviewer(s) and Linked 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: