DOC: Try to keep <code> tags from appearing in rendered docs #1382
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
https://unidata.github.io/netcdf4-python/#netCDF4.Dataset Scroll down to `format`: underlying file format. Not sure if this should be ReST's ``code`` or Markdown's `code`, though the default role Sphinx assigns to single quotes should work (:any:`code`, I think is how sphinx would interpret `code`). In any case, it works everywhere else, so hopefully it works here too.
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.
https://unidata.github.io/netcdf4-python/#netCDF4.Dataset
Scroll down to "
format: underlying file format", which showsThis is also visible in the processed HTML here:
netcdf4-python/docs/index.html
Line 1556 in f7b00f8
I have no idea why it decided to (1) nest the code tags, instead of ending the already-open one and opening a second, nor (2) entity-escape the tags it added so they would show up in the rendered HTML (as opposed to giving directions to the browser).
Not sure if this should be ReST's double-backticks for code or Markdown's single backticks, though the default role Sphinx assigns to single backticks should work (though I have no idea if pdoc has an equivalent concept). In any case, it works everywhere else, so hopefully it works here too.
EDIT: pdoc seems to have an equivalent to Sphinx's
`identifier`->:any:`identifier`magic, at least in that placing a documented identifier in single ticks will link to the documentation for that identifier. It doesn't say whether double-backticks disables that, though.