docs(api): Fix various documentation formatting problems #8444
Conversation
This file contains 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
This didn't work (it got rendered as the literal text `protocol-api-deck-coords`, I think because we're building the HAPI docs as a totally separate thing from the PAPI docs. We can probably fix this, but for now, I'm just removing the link.
These were giving warnings like: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 2 supplied.
This should use "+" to match the "Skipping Wells" heading, which is at the same level of nesting.
…pettes()` docstring formatting.
`ModuleContext` is not something that appears in our documentation (nor IMO should it be), so there's nowhere for these cross-references to go. Instead, link individually to the `.load_labware()` methods of `ThermocyclerContext`, `TemperatureModuleContext`, and `MagneticModuleContext`. Where this would be very clunky, just use the literal text `module.load_labware()` without a link.
Codecov Report
@@ Coverage Diff @@
## edge #8444 +/- ##
==========================================
+ Coverage 74.24% 74.48% +0.23%
==========================================
Files 1670 1672 +2
Lines 45059 45518 +459
Branches 4595 4595
==========================================
+ Hits 33456 33903 +447
- Misses 10810 10822 +12
Partials 793 793
Flags with carried forward coverage won't be shown. Click here to find out more.
|
sanni-t
approved these changes
Oct 1, 2021
SyntaxColoring
commented
Oct 1, 2021
This was referenced Oct 1, 2021
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.
Overview
On the road to #6135, this PR resolves an assortment of Sphinx warnings. Some were benign, but others were causing the documentation to render incorrectly.
Changelog
This is really a whole bunch of little things, so it's probably easiest to just scan through the diff.
Common themes:
Also of note:
api/docs/Makefileandapi/docs/make.bat, which looked like unused cruft. Our docs are normally built withapi/Makefile.Risk assessment and review requests
Low risk. I've been checking the rendered output, so I think we just have to make sure this passes CI and make sure the "code" changes look good.