Skip to content

Commit

Permalink
docs: Updated the mkdocs plugin load order to fix weird capitalizatio…
Browse files Browse the repository at this point in the history
…n issues in the new signal generation doc.

Also fixed a few things in the signal generation doc to make links render properly.
  • Loading branch information
nfelt14 committed Jul 15, 2024
1 parent c574d23 commit 52ab2a1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/advanced/signal_generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Each of these source channel classes (
(or the [IAFG](default:IAFG) in the case of an oscilloscope).

These source channel classes contain methods and properties that pertain to [PI](default:PI) commands, which only apply changes to one output.
For example: the `afg.source_channel\["SOURCE1"\].set_amplitude()` call will change the amplitude only for source output 1.
For example: the `afg.source_channel["SOURCE1"].set_amplitude()` call will change the amplitude only for source output 1.

!!! tip

Expand Down Expand Up @@ -129,7 +129,7 @@ make sure that the parameters you will be supplying
are not outside the bounds. The method only requires the desired waveform function (except on [AWGs](default:AWG)) to be provided.
However, different aspects may need to be provided to get a more accurate representation of what can actually be generated.
If no other inputs are provided, the smallest range of the attribute is chosen.
An [AWG's](default:AWG) signal path affects the range of the offset and amplitude.
For an [AWG](default:AWG), the signal path affects the range of the offset and amplitude.
Higher frequencies on [AFGs](default:AFG) will lower the upper bound of the amplitude,
alongside which impedance is set.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ plugins:
- search:
prebuild_index: true
- include-markdown
- mermaid2
- section-index
- autorefs
- macros:
Expand All @@ -91,6 +90,7 @@ plugins:
use_default: true
inline_refs: none
markdown_links: true
- mermaid2
- mkdocstrings: # additional customization takes place in docs/generate_api_pages.py
# noinspection YAMLIncompatibleTypes
enabled: !ENV [TM_DEVICES_API_GENERATION, true]
Expand Down

0 comments on commit 52ab2a1

Please sign in to comment.