📚 DOCS: Add write-good and improve writing #52
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
gaurav274
pushed a commit
to georgia-tech-db/evadb
that referenced
this pull request
May 22, 2023
Bumps [sphinx-sitemap](https://github.com/jdillard/sphinx-sitemap) from 2.2.0 to 2.5.0. <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.0 (2023-01-28)</h2> <p>Install from <a href="https://pypi.org/project/sphinx-sitemap/2.5.0/">PyPi</a></p> <h2>What's Changed</h2> <ul> <li>:books: DOCS: Calculate version for sitemap based on current tag by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/53">jdillard/sphinx-sitemap#53</a></li> <li>:wrench: MAINT: Add changelog to <code>project.urls</code> by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/54">jdillard/sphinx-sitemap#54</a></li> <li>:test_tube: TESTS: Add Sphinx 6 environment to tox by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/55">jdillard/sphinx-sitemap#55</a></li> <li>:sparkles: NEW: Add support for Sphinx config <code>html_file_suffix</code> by <a href="https://github.com/jdetaeye"><code>@jdetaeye</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/57">jdillard/sphinx-sitemap#57</a></li> <li>:books: DOCS: Add site search optimization by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/58">jdillard/sphinx-sitemap#58</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/jdetaeye"><code>@jdetaeye</code></a> made their first contribution in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/57">jdillard/sphinx-sitemap#57</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.4.0...v2.5.0">https://github.com/jdillard/sphinx-sitemap/compare/v2.4.0...v2.5.0</a></p> <h2>Release 2.4.0 (2022-12-26)</h2> <p>Install from <a href="https://pypi.org/project/sphinx-sitemap/2.4.0/">PyPi</a></p> <h2>What's Changed</h2> <ul> <li>:test_tube: TESTS: Add python 3.11 tests by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/43">jdillard/sphinx-sitemap#43</a></li> <li>:books: DOCS: Add ReadTheDocs docs by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/45">jdillard/sphinx-sitemap#45</a></li> <li>:wrench: MAINT: General code clean up by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/46">jdillard/sphinx-sitemap#46</a></li> <li>:sparkles: NEW: Add support for parallel mode by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/47">jdillard/sphinx-sitemap#47</a></li> <li>:test_tube: TESTS: Add tests for dirhtml builder by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/48">jdillard/sphinx-sitemap#48</a></li> <li>:books: DOCS: Add vale support for docs by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/49">jdillard/sphinx-sitemap#49</a></li> <li>:bug: FIX: Fix wheel includes so they don't include docs and tests by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/51">jdillard/sphinx-sitemap#51</a></li> <li>:books: DOCS: Add write-good and improve writing by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/52">jdillard/sphinx-sitemap#52</a></li> </ul> <p>Shout-out to <a href="https://github.com/xmo-odoo"><code>@xmo-odoo</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/47">#47</a></p> <p><strong>Full Changelog</strong>: <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.3.0...v2.4.0">https://github.com/jdillard/sphinx-sitemap/compare/v2.3.0...v2.4.0</a></p> <h2>Release 2.3.0 (2022-12-21)</h2> <p>Install from <a href="https://pypi.org/project/sphinx-sitemap/2.3.0/">PyPi</a></p> <h2>What's Changed</h2> <ul> <li>:wrench: MAINT: Clean up how package versions are handled by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/34">jdillard/sphinx-sitemap#34</a></li> <li>:wrench: MAINT: Install pre-commit with isort, black, and flake8 by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/35">jdillard/sphinx-sitemap#35</a></li> <li>:books: DOCS: Improve the wording of the README by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/36">jdillard/sphinx-sitemap#36</a></li> <li>:bug: FIX: Follow correct format for multilingual sitemaps by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/38">jdillard/sphinx-sitemap#38</a></li> <li>:wrench: MAINT: Update the build process and provide wheels by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/39">jdillard/sphinx-sitemap#39</a></li> <li>:wrench: MAINT: Add testing infrastructure by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/41">jdillard/sphinx-sitemap#41</a></li> <li>:wrench: MAINT: Add python 3.10 tests and remove flake8 test from tox by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/42">jdillard/sphinx-sitemap#42</a></li> <li>:bug: FIX: Use logging for all logging messages by <a href="https://github.com/jdillard"><code>@jdillard</code></a> in <a href="https://redirect.github.com/jdillard/sphinx-sitemap/pull/40">jdillard/sphinx-sitemap#40</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.2.1...v2.3.0">https://github.com/jdillard/sphinx-sitemap/compare/v2.2.1...v2.3.0</a></p> <h2>Release 2.2.1 (2022-11-11)</h2> <p>Install from <a href="https://pypi.org/project/sphinx-sitemap/2.2.1/">PyPi</a></p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </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.0</h2> <p><em>Release date: 2023-01-28</em></p> <ul> <li>|:books:| DOCS: Calculate version for sitemap based on current tag <code>[#53](jdillard/sphinx-sitemap#53) <https://github.com/jdillard/sphinx-sitemap/pull/53></code>_</li> <li>|:test_tube:| TESTS: Add Sphinx 6 env to tox <code>[#55](jdillard/sphinx-sitemap#55) <https://github.com/jdillard/sphinx-sitemap/pull/55></code>_</li> <li>|:sparkles:| NEW: Add support for Sphinx config "html_file_suffix" <code>[#57](jdillard/sphinx-sitemap#57) <https://github.com/jdillard/sphinx-sitemap/pull/57></code>_</li> <li>|:books:| DOCS: Add site search optimization <code>[#58](jdillard/sphinx-sitemap#58) <https://github.com/jdillard/sphinx-sitemap/pull/58></code>_</li> </ul> <h2>2.4.0</h2> <p><em>Release date: 2022-12-26</em></p> <ul> <li>|:books:| DOCS: Add ReadTheDocs docs <code>[#45](jdillard/sphinx-sitemap#45) <https://github.com/jdillard/sphinx-sitemap/pull/45></code>_</li> <li>|:wrench:| MAINT: General code clean up <code>[#46](jdillard/sphinx-sitemap#46) <https://github.com/jdillard/sphinx-sitemap/pull/46></code>_</li> <li>|:sparkles:| NEW: Add support for parallel mode <code>[#47](jdillard/sphinx-sitemap#47) <https://github.com/jdillard/sphinx-sitemap/pull/47></code>_</li> <li>|:test_tube:| TESTS: Add tests for <code>dirhtml</code> builder <code>[#48](jdillard/sphinx-sitemap#48) <https://github.com/jdillard/sphinx-sitemap/pull/48></code>_</li> <li>|:test_tube:| TESTS: Add vale support for docs <code>[#49](jdillard/sphinx-sitemap#49) <https://github.com/jdillard/sphinx-sitemap/pull/49></code>_</li> <li>|:bug:| FIX: Fix wheel includes so they don't include docs and tests <code>[#51](jdillard/sphinx-sitemap#51) <https://github.com/jdillard/sphinx-sitemap/pull/51></code>_</li> <li>|:books:| DOCS: Add write-good and improve writing <code>[#52](jdillard/sphinx-sitemap#52) <https://github.com/jdillard/sphinx-sitemap/pull/52></code>_</li> </ul> <h2>2.3.0</h2> <p><em>Release date: 2022-12-21</em></p> <ul> <li>|:wrench:| MAINT: Clean up how package versions are handled</li> <li>|:test_tube:| TESTS: Install pre-commit with <code>isort</code>, <code>black</code>, and <code>flake8</code> <code>[#35](jdillard/sphinx-sitemap#35) <https://github.com/jdillard/sphinx-sitemap/pull/35></code>_</li> <li>|:books:| DOCS: Improve the wording of the README to help with issues upgrading to Sphinx 5 <code>[#36](jdillard/sphinx-sitemap#36) <https://github.com/jdillard/sphinx-sitemap/pull/36></code>_</li> <li>|:bug:| FIX: Follow correct format for multilingual sitemaps <code>[#38](jdillard/sphinx-sitemap#38) <https://github.com/jdillard/sphinx-sitemap/pull/38></code>_</li> <li>|:wrench:| MAINT: Update the build process <code>[#39](jdillard/sphinx-sitemap#39) <https://github.com/jdillard/sphinx-sitemap/pull/39></code>_</li> <li>|:test_tube:| TESTS: Add testing infrastructure <code>[#41](jdillard/sphinx-sitemap#41) <https://github.com/jdillard/sphinx-sitemap/pull/41></code>_</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/7ec6ccc443df9b5565e68b3f21ff2f597ca14e19"><code>7ec6ccc</code></a> Bump version to 2.5.0</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/f6c998c41ffeb15f956e587f7ec4451bd83a84b4"><code>f6c998c</code></a> DOCS: Add site search optimization (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/58">#58</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/8eff853b7623c8d911e9e9604b8c0eb56804963b"><code>8eff853</code></a> Update changelog</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/d00702d0043130327fb051c1487979eddf9b6367"><code>d00702d</code></a> Add test for html_file_suffix</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/06450ac9e6ea219c46201bc90edeb94d5e47789f"><code>06450ac</code></a> NEW: Add support for Sphinx config "html_file_suffix". (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/57">#57</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/edf8c48339b6fe56ed2738298303e4ca4b997970"><code>edf8c48</code></a> Be more explicit with python version classifiers</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/c8f29ee03e6d0d0b952e4a2c9a3975fef26837b0"><code>c8f29ee</code></a> TESTS: Add Sphinx 6 env to tox (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/55">#55</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/382be2a6fef956e42e6ba7705f12552d72c72eb7"><code>382be2a</code></a> MAINT: Add changelog to project.urls (<a href="https://redirect.github.com/jdillard/sphinx-sitemap/issues/54">#54</a>)</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/8ca21a916cda43ddf1607b641a2550627b383314"><code>8ca21a9</code></a> DOCS: Improve wording and filenames</li> <li><a href="https://github.com/jdillard/sphinx-sitemap/commit/08229f74d1c72d48068a7edd4d55212cfd12172a"><code>08229f7</code></a> DOCS: Add getting started and move CHANGELOG</li> <li>Additional commits viewable in <a href="https://github.com/jdillard/sphinx-sitemap/compare/v2.2.0...v2.5.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> 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