treat .unparsed as plain text #806
Merged
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
|
Thanks for the quick response, LGTM |
|
I regret that field testing has been the most reliable way to find bugs/shortcomings about v4.33.0. I'll be working on a new PR that will allow the breathe docs to use |
As I don't feel it is completely obvious.
michaeljones
approved these changes
Feb 18, 2022
|
Thanks for the additional comment in breathe's src. I'm ok to merge if there are no objections. |
|
Ace, thanks for handling it! |
Merged
github-actions bot
added a commit
to Diapolo10/lidar-projekti
that referenced
this pull request
Mar 1, 2023
Bumps [breathe](https://github.com/michaeljones/breathe) from 4.34.0 to 4.35.0. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/breathe-doc/breathe/blob/main/CHANGELOG.rst">breathe's changelog</a>.</em></p> <blockquote> <h2>Change Log</h2> <p>Inspired by <code>Keepachangelog.com <http://keepachangelog.com/></code>__.</p> <ul> <li> <p>2023-02-28 - <strong>Breathe v4.35.0</strong></p> <ul> <li>Pull lone literal blocks in paragraphs up to produce correct doctree. <code>[#833](breathe-doc/breathe#833) <https://github.com/michaeljones/breathe/pull/833></code>__</li> <li>Fix tests for changes in Sphinx 5.3. <code>[#865](breathe-doc/breathe#865) <https://github.com/breathe-doc/breathe/pull/865></code>__</li> <li>Bump Python requirement to 3.7. <code>[#866](breathe-doc/breathe#866) <https://github.com/breathe-doc/breathe/pull/866></code>__</li> <li>Support Sphinx 6. <code>[#885](breathe-doc/breathe#885) <https://github.com/breathe-doc/breathe/pull/885></code>__</li> <li>Support <code>:sort:</code> option to sort sections by name. <code>[#879](breathe-doc/breathe#879) <https://github.com/breathe-doc/breathe/pull/879></code>__</li> </ul> </li> <li> <p>2022-06-20 - <strong>Breathe v4.34.0</strong></p> <ul> <li>Treat .unparsed as plain text. <code>[#806](breathe-doc/breathe#806) <https://github.com/michaeljones/breathe/pull/806></code>__</li> <li>Remove unneeded type: ignore annotations. <code>[#813](breathe-doc/breathe#813) <https://github.com/michaeljones/breathe/pull/813></code>__</li> <li>Fix internal <code>NodeFinder</code> visitor for when non-Docutils nodes are present in the content of a directive. <code>[#812](breathe-doc/breathe#812) <https://github.com/michaeljones/breathe/pull/812></code>__</li> <li>Rename lint workflow. <code>[#814](breathe-doc/breathe#814) <https://github.com/michaeljones/breathe/pull/814></code>__</li> <li>Type check pygments and limit docutils stub version. <code>[#819](breathe-doc/breathe#819) <https://github.com/michaeljones/breathe/pull/819></code>__</li> <li>Convert dot files' relative path to absolute. <code>[#821](breathe-doc/breathe#821) <https://github.com/michaeljones/breathe/pull/821></code>__</li> <li>CI, update Sphinx versions to test. <code>[#834](breathe-doc/breathe#834) <https://github.com/michaeljones/breathe/pull/834></code>__</li> <li>CI, update for Sphinx 5.0.1. <code>[#846](breathe-doc/breathe#846) <https://github.com/michaeljones/breathe/pull/846></code>__</li> <li>Fix inconsistency in example. <code>[#843](breathe-doc/breathe#843) <https://github.com/michaeljones/breathe/pull/843></code>__</li> <li>Fix C# enum rendering crash. <code>[#849](breathe-doc/breathe#849) <https://github.com/michaeljones/breathe/pull/849></code>__</li> <li>Drop Sphinx 3 support, add Sphinx 5 support. <code>[#850](breathe-doc/breathe#850) <https://github.com/michaeljones/breathe/pull/850></code>__</li> <li>CICD: Disable python 3.6 for Sphinx master tests. <code>[#853](breathe-doc/breathe#853) <https://github.com/michaeljones/breathe/pull/853></code>__</li> <li>Populate default include text-node's data field instead of raw-source. <code>[#828](breathe-doc/breathe#828) <https://github.com/michaeljones/breathe/pull/828></code>__</li> </ul> </li> <li> <p>2022-02-14 - <strong>Breathe v4.33.1</strong></p> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/breathe-doc/breathe/commit/4e9f55eadc91d96ac155a24c3634359b511a82cd"><code>4e9f55e</code></a> version: release v4.35.0</li> <li><a href="https://github.com/breathe-doc/breathe/commit/b4564e9b7f654cc23907f4e346ed79f1447a9cba"><code>b4564e9</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/michaeljones/breathe/issues/885">#885</a> from breathe-doc/sphinx-6</li> <li><a href="https://github.com/breathe-doc/breathe/commit/42585399bf666b0c673b222291c4886700ec283e"><code>4258539</code></a> Remove <7 constraint from setup.py</li> <li><a href="https://github.com/breathe-doc/breathe/commit/86298ccf2fd8ead0867a2ac74ac894a9ef25bb67"><code>86298cc</code></a> Remove <7 constraint from requirement file</li> <li><a href="https://github.com/breathe-doc/breathe/commit/81a92d8ea06fe4dd43cea85282b1ad092e58c3c4"><code>81a92d8</code></a> Update changelog with latest changes</li> <li><a href="https://github.com/breathe-doc/breathe/commit/687a3278e894b461df3ea00d6c6b2da140757728"><code>687a327</code></a> Adjust constraint in production requirements.txt</li> <li><a href="https://github.com/breathe-doc/breathe/commit/00b29e83541c2f4b16b1c0bd4d1abfb0c2a31834"><code>00b29e8</code></a> Adjust constraint setup.py</li> <li><a href="https://github.com/breathe-doc/breathe/commit/ef4e245804759d44ae54fc832b4d5155837f0720"><code>ef4e245</code></a> Add Sphinx 6.1.3 to test matrix</li> <li><a href="https://github.com/breathe-doc/breathe/commit/c4013f49c1a99b70c12d45325d5f413a9c7f7960"><code>c4013f4</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/michaeljones/breathe/issues/879">#879</a> from schlatterbeck/sort-groups</li> <li><a href="https://github.com/breathe-doc/breathe/commit/d75073d73c9bec4954d691d50d30704fd09a4a14"><code>d75073d</code></a> Bump clang again</li> <li>Additional commits viewable in <a href="https://github.com/michaeljones/breathe/compare/v4.34.0...v4.35.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
github-actions bot
added a commit
to MaRDI4NFDI/open-interfaces
that referenced
this pull request
Mar 6, 2023
Bumps [breathe](https://github.com/michaeljones/breathe) from 4.34.0 to 4.35.0. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/breathe-doc/breathe/blob/main/CHANGELOG.rst">breathe's changelog</a>.</em></p> <blockquote> <h2>Change Log</h2> <p>Inspired by <code>Keepachangelog.com <http://keepachangelog.com/></code>__.</p> <ul> <li> <p>2023-02-28 - <strong>Breathe v4.35.0</strong></p> <ul> <li>Pull lone literal blocks in paragraphs up to produce correct doctree. <code>[#833](breathe-doc/breathe#833) <https://github.com/michaeljones/breathe/pull/833></code>__</li> <li>Fix tests for changes in Sphinx 5.3. <code>[#865](breathe-doc/breathe#865) <https://github.com/breathe-doc/breathe/pull/865></code>__</li> <li>Bump Python requirement to 3.7. <code>[#866](breathe-doc/breathe#866) <https://github.com/breathe-doc/breathe/pull/866></code>__</li> <li>Support Sphinx 6. <code>[#885](breathe-doc/breathe#885) <https://github.com/breathe-doc/breathe/pull/885></code>__</li> <li>Support <code>:sort:</code> option to sort sections by name. <code>[#879](breathe-doc/breathe#879) <https://github.com/breathe-doc/breathe/pull/879></code>__</li> </ul> </li> <li> <p>2022-06-20 - <strong>Breathe v4.34.0</strong></p> <ul> <li>Treat .unparsed as plain text. <code>[#806](breathe-doc/breathe#806) <https://github.com/michaeljones/breathe/pull/806></code>__</li> <li>Remove unneeded type: ignore annotations. <code>[#813](breathe-doc/breathe#813) <https://github.com/michaeljones/breathe/pull/813></code>__</li> <li>Fix internal <code>NodeFinder</code> visitor for when non-Docutils nodes are present in the content of a directive. <code>[#812](breathe-doc/breathe#812) <https://github.com/michaeljones/breathe/pull/812></code>__</li> <li>Rename lint workflow. <code>[#814](breathe-doc/breathe#814) <https://github.com/michaeljones/breathe/pull/814></code>__</li> <li>Type check pygments and limit docutils stub version. <code>[#819](breathe-doc/breathe#819) <https://github.com/michaeljones/breathe/pull/819></code>__</li> <li>Convert dot files' relative path to absolute. <code>[#821](breathe-doc/breathe#821) <https://github.com/michaeljones/breathe/pull/821></code>__</li> <li>CI, update Sphinx versions to test. <code>[#834](breathe-doc/breathe#834) <https://github.com/michaeljones/breathe/pull/834></code>__</li> <li>CI, update for Sphinx 5.0.1. <code>[#846](breathe-doc/breathe#846) <https://github.com/michaeljones/breathe/pull/846></code>__</li> <li>Fix inconsistency in example. <code>[#843](breathe-doc/breathe#843) <https://github.com/michaeljones/breathe/pull/843></code>__</li> <li>Fix C# enum rendering crash. <code>[#849](breathe-doc/breathe#849) <https://github.com/michaeljones/breathe/pull/849></code>__</li> <li>Drop Sphinx 3 support, add Sphinx 5 support. <code>[#850](breathe-doc/breathe#850) <https://github.com/michaeljones/breathe/pull/850></code>__</li> <li>CICD: Disable python 3.6 for Sphinx master tests. <code>[#853](breathe-doc/breathe#853) <https://github.com/michaeljones/breathe/pull/853></code>__</li> <li>Populate default include text-node's data field instead of raw-source. <code>[#828](breathe-doc/breathe#828) <https://github.com/michaeljones/breathe/pull/828></code>__</li> </ul> </li> <li> <p>2022-02-14 - <strong>Breathe v4.33.1</strong></p> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/breathe-doc/breathe/commit/4e9f55eadc91d96ac155a24c3634359b511a82cd"><code>4e9f55e</code></a> version: release v4.35.0</li> <li><a href="https://github.com/breathe-doc/breathe/commit/b4564e9b7f654cc23907f4e346ed79f1447a9cba"><code>b4564e9</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/michaeljones/breathe/issues/885">#885</a> from breathe-doc/sphinx-6</li> <li><a href="https://github.com/breathe-doc/breathe/commit/42585399bf666b0c673b222291c4886700ec283e"><code>4258539</code></a> Remove <7 constraint from setup.py</li> <li><a href="https://github.com/breathe-doc/breathe/commit/86298ccf2fd8ead0867a2ac74ac894a9ef25bb67"><code>86298cc</code></a> Remove <7 constraint from requirement file</li> <li><a href="https://github.com/breathe-doc/breathe/commit/81a92d8ea06fe4dd43cea85282b1ad092e58c3c4"><code>81a92d8</code></a> Update changelog with latest changes</li> <li><a href="https://github.com/breathe-doc/breathe/commit/687a3278e894b461df3ea00d6c6b2da140757728"><code>687a327</code></a> Adjust constraint in production requirements.txt</li> <li><a href="https://github.com/breathe-doc/breathe/commit/00b29e83541c2f4b16b1c0bd4d1abfb0c2a31834"><code>00b29e8</code></a> Adjust constraint setup.py</li> <li><a href="https://github.com/breathe-doc/breathe/commit/ef4e245804759d44ae54fc832b4d5155837f0720"><code>ef4e245</code></a> Add Sphinx 6.1.3 to test matrix</li> <li><a href="https://github.com/breathe-doc/breathe/commit/c4013f49c1a99b70c12d45325d5f413a9c7f7960"><code>c4013f4</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/michaeljones/breathe/issues/879">#879</a> from schlatterbeck/sort-groups</li> <li><a href="https://github.com/breathe-doc/breathe/commit/d75073d73c9bec4954d691d50d30704fd09a4a14"><code>d75073d</code></a> Bump clang again</li> <li>Additional commits viewable in <a href="https://github.com/michaeljones/breathe/compare/v4.34.0...v4.35.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
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.
This fixes #805.
According to the doxygen manual, users can specify a file extension called .unparsed to disable syntax highlighting. Since this isn't a real language that pygments supports, there was a warning generated when users followed the doxygen manual.
This is a simple patch that replaces the "unparsed" file extension with "text" to invoke pygments' null highlighting lexer.
I also added a code block (that uses
\code{.unparsed}) to the doc's example snippets in the codeblocks.rst (and examples/specific/code_blocks.h) to verify this warning is properly suppressed.