doc: Fix end-of-file newline in update_devs.py - #751
Open
tfcollins wants to merge 8 commits into
Open
Conversation
Split the Quick Start, Examples, and Developer Guide into focused sub-sections. Reorganized the supported device list into logical categories (Transceivers, Converters, etc.). Added new guides for Architecture, Performance Optimization, and Troubleshooting.
Modified update_devs.py to support categorized device listing in index.rst. Fixed trailing whitespace and formatting in troubleshooting and performance guides. Ensured check_for_missing.py passes by keeping auto-generated files in sync.
|
Generated documentation for this PR is available at Link |
Updated update_devs.py to include manual device RST files (adis*) in the categorized index.rst. This resolves 'document isn't included in any toctree' warnings that were causing CI failures with SPHINXOPTS='-W'.
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
1 participant
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.
Description
Summarize the change and the motivation. Link the issue this fixes.
Fixes # (issue)
Type of change
How has this been tested?
State explicitly whether this was tested against real hardware, an emulated context (iio-emu), or not run. Name the part(s) and the context URI or board used.
python3 -m pytest -k ad4080 --adi-hw-map):Test configuration
Documentation
doc/source/New device class interfaces
Skip this section if the PR does not add a new device class.
adi.device_base(rx_chan_comp,tx_chan_comp, or a_no_buffvariant). If not, explain why in the description. See the Device Base Classes developer doc page.compatible_partslists every part number this class supportssupported_parts.md(verify withinvoke checkparts)test/emu/and referenced from a testChecklist
invoke precommitpasses locallySigned-off-by: Name <email>)