fba2f135a3
Update sphinx requirement from <6,>=5 to >=5,<9 ( #542 )
...
Updates the requirements on
[sphinx](https://github.com/sphinx-doc/sphinx ) to permit the latest
version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/sphinx-doc/sphinx/releases ">sphinx's
releases</a>.</em></p>
<blockquote>
<h2>Sphinx 8.1.3</h2>
<p>Changelog: <a
href="https://www.sphinx-doc.org/en/master/changes/8.1.html ">https://www.sphinx-doc.org/en/master/changes/8.1.html </a></p>
<h2>Bugs fixed</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13013 ">#13013</a>:
Restore support for <code>cut_lines()</code> with no object type. Patch
by Adam Turner.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/sphinx-doc/sphinx/blob/v8.1.3/CHANGES.rst ">sphinx's
changelog</a>.</em></p>
<blockquote>
<h1>Release 8.1.3 (released Oct 13, 2024)</h1>
<h2>Bugs fixed</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13013 ">#13013</a>:
Restore support for :func:<code>!cut_lines</code> with no object type.
Patch by Adam Turner.</li>
</ul>
<h1>Release 8.1.2 (released Oct 12, 2024)</h1>
<h2>Bugs fixed</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13012 ">#13012</a>:
Expose :exc:<code>sphinx.errors.ExtensionError</code> in
<code>sphinx.util</code>
for backwards compatibility.
This will be removed in Sphinx 9, as exposing the exception
in <code>sphinx.util</code> was never intentional.
:exc:<code>!ExtensionError</code> has been part of
<code>sphinx.errors</code> since Sphinx 0.9.
Patch by Adam Turner.</li>
</ul>
<h1>Release 8.1.1 (released Oct 11, 2024)</h1>
<h2>Bugs fixed</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13006 ">#13006</a>:
Use the preferred <a
href="https://www.cve.org/ ">https://www.cve.org/ </a> URL for
the :rst:role:<code>:cve: <cve></code> role.
Patch by Hugo van Kemenade.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13007 ">#13007</a>:
LaTeX: Improve resiliency when the required
<code>fontawesome</code> or <code>fontawesome5</code> packages are not
installed.
Patch by Jean-François B.</li>
</ul>
<h1>Release 8.1.0 (released Oct 10, 2024)</h1>
<h2>Dependencies</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/12756 ">#12756</a>:
Add lower-bounds to the <code>sphinxcontrib-*</code> dependencies.
Patch by Adam Turner.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/12833 ">#12833</a>:
Update the LaTeX <code>parskip</code> package from 2001 to 2018.
Patch by Jean-François B.</li>
</ul>
<h2>Incompatible changes</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/12763 ">#12763</a>:
Remove unused internal class <code>sphinx.util.Tee</code>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/a1510de4777eaa2e569435f95b05f6f3293d7035 "><code>a1510de</code></a>
Bump to 8.1.3 final</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/62e9606d63c8bbb4964213fd6b427d1483847662 "><code>62e9606</code></a>
Restore support for <code>cut_lines()</code> with no object type (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13015 ">#13015</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/5ae32ce9bfe4a17a7f00e1e8d39a80449423c726 "><code>5ae32ce</code></a>
Bump version</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/a72b47bb408923cb7809eb9f96885545184e3773 "><code>a72b47b</code></a>
Bump to 8.1.2 final</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/39a45ad4073a4d8c3b7dfd64d22e8a88870dcc7c "><code>39a45ad</code></a>
Expose <code>ExtensionError</code> in <code>sphinx.util</code> for
backwards compatibility.</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/5a4859a2e489c66b38804e95bf77fd0baf4320dc "><code>5a4859a</code></a>
Add docs about sphinx-autobuild (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13011 ">#13011</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/05679efe7b34f8b2fb87605438c40248ac8cae83 "><code>05679ef</code></a>
Type-check the 'autodoc_intenum' example (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/12827 ">#12827</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/86d1d31fb370f031739079de7d827be0074e7661 "><code>86d1d31</code></a>
Prune CHANGES of unneeded sections</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/b6269d3790bb3bdd652ce67fecb59e6afddc8014 "><code>b6269d3</code></a>
Improve documentation for the Builder API (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13008 ">#13008</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/c46abc47210088a6c4fee9dac23badfcebc441d7 "><code>c46abc4</code></a>
Improve clarity for <code>master_doc</code> and
<code>root_doc</code></li>
<li>Additional commits viewable in <a
href="https://github.com/sphinx-doc/sphinx/compare/v5.0.0...v8.1.3 ">compare
view</a></li>
</ul>
</details>
<br />
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>
2024-10-24 07:37:38 -04:00
dcadba1425
Docs: Update to jinja2<3.2, Dependabot admonitions versions <3.1.4
2024-10-24 01:36:07 +02:00
1fd9a682dd
Docs: Fix broken links
2024-10-24 01:17:54 +02:00
5d3e650901
Docs: Update dependencies, fixing the build on Python 3.11
2024-10-24 01:13:22 +02:00
48d082e6a5
Docs: Use relaxed upper-bound dependency pinning for Sphinx dependencies
2024-10-24 01:04:38 +02:00
87e22481e8
Docs: Clean up docs/requirements.txt. It just needs Sphinx and friends.
2024-10-24 01:04:08 +02:00
a802853367
Bump bleach from 3.1.1 to 3.1.4 in /docs
...
Bumps [bleach](https://github.com/mozilla/bleach ) from 3.1.1 to 3.1.4.
- [Release notes](https://github.com/mozilla/bleach/releases )
- [Changelog](https://github.com/mozilla/bleach/blob/master/CHANGES )
- [Commits](https://github.com/mozilla/bleach/compare/v3.1.1...v3.1.4 )
Signed-off-by: dependabot[bot] <support@github.com >
2020-12-01 23:11:49 +00:00
a57570210a
Add prettier to pre-commit
2020-12-01 23:36:42 +01:00
783b22ab1c
Bump bleach from 3.0.2 to 3.1.1 in /docs
...
Bumps [bleach](https://github.com/mozilla/bleach ) from 3.0.2 to 3.1.1.
- [Release notes](https://github.com/mozilla/bleach/releases )
- [Changelog](https://github.com/mozilla/bleach/blob/master/CHANGES )
- [Commits](https://github.com/mozilla/bleach/compare/v3.0.2...v3.1.1 )
Signed-off-by: dependabot[bot] <support@github.com >
2020-02-24 18:31:05 +00:00
86361523e2
fix async templates rendering requiring enable_async in jinja2
...
When trying to test the render_async() feature I realized that it wasn't working
The template instance needs to be created with enable_async=True
2019-10-19 14:49:50 +02:00
df85a4c214
Merge pull request #388 from taoufik07/new-router
...
New Router and refactor
2019-09-03 20:13:46 +02:00
97dbef92d9
Bump werkzug version to 0.15.5 in docs
2019-08-21 23:05:27 +02:00
85c1c0036c
[WIP] Update docs
2019-08-21 22:50:58 +02:00
3a8113d8b0
Found more --pre flags
2019-07-16 07:43:55 -07:00
70e6bc0466
add some links to the main page
...
Basically linked things I had to google/look up on my own. There are a million things that _could_ be linked, but using myself as a median Python coder, it seems about right. Removed italics because I can't figure out how to use them with a link.
2019-06-25 08:21:07 -07:00
fb71abe534
Update tour.rst to add quotes around hostnames
...
The API call in the Trusted Hosts section needs quotes around the hostnames in the example.
2019-06-04 11:21:27 -04:00
cf5447d5bd
Typo schema docs
2019-04-28 15:59:15 +02:00
f21b296fba
Add docs for route params convertors
2019-04-27 20:10:31 +02:00
4957793c80
feat: add search to every documentation pages
2019-04-22 22:23:07 +02:00
ff7f4b502d
feat: add search to the main introduction page
2019-04-22 22:22:46 +02:00
ebed9fe3aa
fix typos
2019-03-17 19:05:14 -04:00
734b5e7303
add sample of uploading a file
2019-03-17 15:21:27 -04:00
37318f1106
Update tour.rst
2019-03-10 14:53:44 +01:00
885d902b7d
Revert
2019-02-26 23:46:07 +01:00
b876f8484c
Update docs
2019-02-26 17:01:13 +01:00
d1f7fe02e4
fix typo
2019-02-24 00:10:47 +09:00
3382723457
fixed flow between OpenAPI and Interactive Docs sections
2019-02-22 06:16:45 -07:00
2ad351197e
Merge pull request #304 from taoufik07/content_type
...
Add resp.html property and make resp.text a property
2019-02-22 10:12:46 +00:00
d4191030d9
Merge branch 'master' into multiple_cookies_and_directives
2019-02-22 10:33:53 +01:00
447630a051
Merge branch 'master' into content_type
2019-02-22 10:30:38 +01:00
0030993631
api OpenAPI params match /docs display order, updated tour docs and docs test
2019-02-21 18:35:19 -07:00
13ba2f72f5
Update docs
2019-02-22 02:00:12 +01:00
9f39917895
Update docs and README
2019-02-22 01:12:25 +01:00
kennethreitz
c045586997
Merge pull request #267 from valtyr/graphql-context
...
Add Request and Response to GraphQL context
2018-12-29 07:05:26 -05:00
kennethreitz
734ba64965
Merge pull request #264 from sangheestyle/master
...
fix typo
2018-12-29 07:04:53 -05:00
60b0c5f256
Update
2018-12-25 01:32:38 +00:00
c8627939de
Update
2018-12-25 01:18:44 +00:00
9144f0158a
Websocket docs
2018-12-25 01:15:54 +00:00
d541aca80f
Mention the GraphQL context object in docs
2018-12-23 13:28:50 +00:00
e2493b489d
fix typo
2018-12-20 17:54:15 +02:00
kennethreitz
a81a348bce
Merge pull request #245 from cdfuller/add-monospace-default
...
Add monospace fallback for preformatted text in docs
2018-12-12 03:57:55 -05:00
a5532614a2
Grammatical fix
...
Grammar: `into to` to `into`
2018-11-26 19:30:20 -06:00
5599ec2809
Add monospace fallback for preformatted text
2018-11-20 09:37:30 -06:00
1b024b8092
Fix issue in OpenAPI Schema Support example
...
`PetSchema().dump()` returns a dict. Calling `.data` on it causes an AttributeError.
2018-11-15 11:19:11 +01:00
8e8e99ed2e
Bring testominials in line with README
2018-11-09 18:25:53 +00:00
a4f5a111c7
Fix OpenAPI version in examples
...
The example for "OpenAPI Schema Support" and "Interactive Documentation had `openapi="3.0"` which would cause the following error when swagger UI tried to render the schema:
```
Unable to render this definition
The provided definition does not specify a valid version field.
Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).
```
2018-11-06 10:46:30 +01:00
kennethreitz
c65e585493
Merge pull request #192 from vlcinsky/fix_doc_typo
...
Fixed missing `.data` on Marshmallow dump
2018-11-05 17:40:06 -05:00
1daa4c202b
fix Dockerfile
2018-11-06 00:47:09 +08:00
45d6c1389d
Fixed missing .data on Marshmallow dump
2018-11-04 22:06:54 +01:00
kennethreitz
db45251f7f
Merge pull request #182 from rparrapy/patch-1
...
Fix typo
2018-10-31 17:39:02 -04:00
dependabot[bot]
kennethreitz