🔧 MAINT: Add docstrings and type hints #61
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
jdillard
changed the title
kai687
pushed a commit
to kai687/sphinxawesome-theme
that referenced
this pull request
Aug 21, 2023
[//]: # (dependabot-start)⚠️ **Dependabot is rebasing this PR**⚠️ Rebasing might not happen immediately, so don't worry if this takes some time. Note: if you make any changes to this PR yourself, they will take precedence over the rebase. --- [//]: # (dependabot-end) Bumps [sphinx-sitemap](https://github.com/jdillard/sphinx-sitemap) from 2.5.0 to 2.5.1. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/jdillard/sphinx-sitemap/releases">sphinx-sitemap's releases</a>.</em></p> <blockquote> <h2>Release 2.5.1 (2023-08-17)</h2> <p>Install from <a href="https://pypi.org/project/sphinx-sitemap/2.5.1/">PyPi</a></p> <h2>What's Changed</h2> <ul> <li>:bug: FIX: Fix incremental building by preventing multiprocessing queue from being pickled with environment by <a href="https://github.com/bstrdsmkr"><code>@bstrdsmkr</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/62">jdillard/sphinx-sitemap#62</a></li> <li>:wrench: MAINT: Add docstrings and type hints by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/61">jdillard/sphinx-sitemap#61</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/63">jdillard/sphinx-sitemap#63</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/65">jdillard/sphinx-sitemap#65</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/68">jdillard/sphinx-sitemap#68</a></li> <li>:bug: FIX: Fix Path use for Sphinx 7.2 by <a href="https://github.com/larsoner"><code>@larsoner</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/70">jdillard/sphinx-sitemap#70</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/bstrdsmkr"><code>@bstrdsmkr</code></a> made their first contribution in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/62">jdillard/sphinx-sitemap#62</a></li> <li><a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> made their first contribution in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/63">jdillard/sphinx-sitemap#63</a></li> <li><a href="https://github.com/larsoner"><code>@larsoner</code></a> made their first contribution in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/70">jdillard/sphinx-sitemap#70</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.5.0...v2.5.1">https://github.com/jdillard/sphinx-sitemap/compare/v2.5.0...v2.5.1</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/jdillard/sphinx-sitemap/blob/master/CHANGELOG.rst">sphinx-sitemap's changelog</a>.</em></p> <blockquote> <h2>2.5.1</h2> <p><em>Release date: 2023-08-17</em></p> <ul> <li>|:bug:| FIX: Fix Path use for Sphinx 7.2 <code>[#70](jdillard/sphinx-sitemap#70) <https://github.com/jdillard/sphinx-sitemap/pull/70></code>_</li> <li>|:bug:| FIX: Fix incremental building by preventing multiprocessing queue from being pickled with environment <code>[#62](jdillard/sphinx-sitemap#62) <https://github.com/jdillard/sphinx-sitemap/pull/62></code>_</li> <li>|:wrench:| MAINT: Add docstrings and type hints <code>[#61](jdillard/sphinx-sitemap#61) <https://github.com/jdillard/sphinx-sitemap/pull/61></code>_</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/f1a5339a7f76c9c51e05218ca07b8267bb008d68"><code>f1a5339</code></a> Prep for v2.5.1</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/eff9209f1458fb9c4afed87f101c9bed96aed73e"><code>eff9209</code></a> Fix typo</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/fe8e3e43b9723a6d28ae2a81521df8b6a2d36c4a"><code>fe8e3e4</code></a> FIX: Fix Path use for Sphinx 7.2 (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/70">#70</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/af2f37985b435210b7aa03e216b2ee1b0ba249fc"><code>af2f379</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/68">#68</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/3bd87ef166bc9f3758d360ad4d23b524668b161d"><code>3bd87ef</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/65">#65</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/912e9d312402f123fb9db3840ee060ec54505f61"><code>912e9d3</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/63">#63</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/19d8fe38bd0cdefb62a52041c813f7f0d2cf39a1"><code>19d8fe3</code></a> MAINT: Add docstrings and type hints (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/61">#61</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/65516cf0fa6b599590aefe746bd344aeae44c26f"><code>65516cf</code></a> FIX: Fix incremental building by preventing multiprocessing queue from being ...</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/c28221dcee8af8a1dfed149ab91e2af53121e6b1"><code>c28221d</code></a> Add language server</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/8a96595864b3e02ae0debc86c8fa883686391bbd"><code>8a96595</code></a> Fix typo</li> <li>Additional commits viewable in <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.5.0...v2.5.1">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 show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@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> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.
Summary of changes
Notes
Taken from the following work by @neflyte:
Co-authored-by: Alan Lew alan@ethereal.cc