Reduce Sphinx documentation build warnings#800
Open
johnjasa wants to merge 5 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reduce Sphinx documentation build warnings
Reduces the docs build warning count from roughly 880 to about 17.
napoleon_use_ivar, and suppressed theetoc.toctreecategory._autosummary/files at the start of every build.Methods:docstring sections and added:no-index:to hand-authored autoclass directives that duplicated autosummary entries.pysam-optionslabel, a broken image path, and a broken literalinclude path.Section 1: Type of Contribution
Section 2: Draft PR Checklist
TODO:
Type of Reviewer Feedback Requested (on Draft PR)
Structural feedback: Confirm the additions to
docs/_config.yml(napoleon_use_ivar,napoleon_custom_sections,suppress_warnings) are acceptable long-term.Other feedback: N/A
Section 3: General PR Checklist
docs/files are up-to-date, or added when necessaryCHANGELOG.mdSection 4: Related Issues
Mostly addresses #548
Section 5: Impacted Areas of the Software
Section 5.1: New Files
N/A
Section 5.2: Modified Files
Docs config and build:
docs/_config.yml,docs/build_book.sh,docs/technology_models/iron_ewin.md.Doc content and cross-references:
docs/control/system_level_control/control_classifier.md,docs/control/technology_level_control/open-loop_controllers.md,docs/developer_guide/adding_a_new_technology.md,docs/developer_guide/testing.md,docs/resource/resource_index.md,docs/resource/solar_index.md,docs/technology_models/geologic_hydrogen.md,docs/technology_models/nuclear.md,docs/technology_models/tidal.md,docs/technology_models/windpower_wind_plant.md.Source-tree docstring fixes:
h2integrate/finances/{profast_base,profast_lco}.py,h2integrate/resource/{river,tidal}.py,h2integrate/storage/battery/pysam_battery.py,h2integrate/control/control_rules/plant_dispatch_model.py,h2integrate/control/control_strategies/{pyomo_storage_controller_baseclass,storage/openloop_storage_control_base,storage/plm_openloop_storage_controller}.py,h2integrate/converters/ammonia/{ammonia_synloop_performance,ammonia_synloop_cost}.py,h2integrate/converters/hydrogen/geologic/templeton_serpentinization.py,h2integrate/converters/nitrogen/simple_ASU.py,h2integrate/converters/solar/atb_res_com_pv_cost.py,h2integrate/converters/steel/{cmu_electric_arc_furnace_dri,cmu_electric_arc_furnace_scrap}.py,h2integrate/converters/wind/wind_plant_ard.py,h2integrate/core/{h2integrate_model,file_utils,model_baseclasses}.py,h2integrate/resource/solar/nlr_developer_goes_api_models.py,h2integrate/storage/hydrogen/h2_storage_cost.py,h2integrate/storage/test/test_storage_performance_model.py.Section 6: Additional Supporting Information
Local build reports
build succeeded, 17 warnings(12 unique categories) versus roughly 880 previously. Remaining warnings are all environment-related on my Windows machine.Section 7: Test Results, if applicable
N/A. This PR does not change runtime behavior; only docstrings and doc-source content.