New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs #102

Merged

astrojuanlu merged 10 commits into master from fix-docs

Nov 8, 2021

Contributor

astrojuanlu commented Nov 8, 2021

No description provided.

astrojuanlu added 2 commits

November 8, 2021 16:50


          Pin docutils

a3758ae


          Modernize Read the Docs build environment

fe5e42b

ericholscher approved these changes

View reviewed changes

astrojuanlu added 2 commits

November 8, 2021 16:59


          Cap Python version

d23465e


          Add Node.js

4f8c738

Contributor Author

astrojuanlu commented Nov 8, 2021

@humitos @stsewd What would be the recommended way to install Node.js packages with the new build specification? I get this error, probably because jsdoc was installed in the old images:

sphinx.errors.SphinxError: jsdoc was not found. Install it using "npm install -g jsdoc".

Sphinx error:
jsdoc was not found. Install it using "npm install -g jsdoc".

stsewd reviewed

View reviewed changes

docs/requirements.txt Show resolved Hide resolved

astrojuanlu added 2 commits

November 8, 2021 17:11


          Cap docutils in old Sphinx versions

17810c5


          Install jsdoc to build documentation

4df18cb

astrojuanlu force-pushed the fix-docs branch from 6f76dd7 to 4df18cb Compare

November 8, 2021 16:27

astrojuanlu added 3 commits

November 8, 2021 17:31


          Upgrade sphinx_rtd_theme

a452c11


          Upgrade Sphinx for documentation

e14eade


          Upgrade sphinx-tabs as well

fce78e5

Contributor Author

astrojuanlu commented Nov 8, 2021

The conflict is caused by:
    The user requested docutils==0.17.1
    sphinx 4.2.0 depends on docutils<0.18 and >=0.14
    sphinx-tabs 3.2.0 depends on docutils~=0.16.0

🤬


          Switch to older versions

Contributor Author

astrojuanlu commented Nov 8, 2021

This finally looks good again ✔️

astrojuanlu enabled auto-merge

November 8, 2021 16:56

astrojuanlu merged commit ef1c782 into master

astrojuanlu deleted the fix-docs branch

November 8, 2021 17:27

humitos reviewed

View reviewed changes

tox.ini

@@ @@ -13,6 +13,7 @@ deps = @@
                 sphinx1: Sphinx<2.0
                 sphinx2: Sphinx<3.0
                 sphinx3: Sphinx<4.0
+                {sphinx1,sphinx2,sphinx3}: docutils<0.18

Member

humitos Nov 9, 2021

oh! Nice trick! I didn't know this one 💯

tompollard added a commit to MIT-LCP/wfdb-python that referenced this pull request


          build(deps): bump readthedocs-sphinx-search from 0.1.1 to 0.3.2 in /d…

05b3fde

…ocs (#477)

Bumps
[readthedocs-sphinx-search](https://github.com/readthedocs/readthedocs-sphinx-search)
from 0.1.1 to 0.3.2.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/readthedocs/readthedocs-sphinx-search/blob/main/CHANGELOG.rst">readthedocs-sphinx-search's
changelog</a>.</em></p>
<blockquote>
<h2>Version 0.3.2</h2>
<p>:Date: Jan 15, 2024</p>
<ul>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>:
Security fix, more information in <code>GHSA-xgfm-fjx6-62mj
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/security/advisories/GHSA-xgfm-fjx6-62mj&gt;</code>__.</li>
</ul>
<h2>Version 0.3.1</h2>
<p>:Date: Mar 27, 2023</p>
<ul>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Add
missing static file (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/135">#135</a>)</li>
</ul>
<h2>Version 0.3.0</h2>
<p>:Date: Mar 27, 2023</p>
<ul>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Use
the search API V3 and add support for custom filters (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/132">#132</a>)</li>
</ul>
<h2>Version 0.2.0</h2>
<p>:Date: Jan 24, 2023</p>
<p>This version adds support for sphinx 6.x,
and makes JQuery optional for animations.</p>
<ul>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: CI:
fix tests (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/127">#127</a>)</li>
<li><a
href="https://github.com/dependabot"><code>@dependabot</code></a>[bot]:
Bump decode-uri-component from 0.2.0 to 0.2.2 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/120">#120</a>)</li>
<li><a
href="https://github.com/dependabot"><code>@dependabot</code></a>[bot]:
Bump minimatch and gulp (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/119">#119</a>)</li>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>:
Refactor: don't depend on underscore.js (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/116">#116</a>)</li>
<li><a href="https://github.com/stsewd"><code>@stsewd</code></a>:
Remove usage of jquery (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/115">#115</a>)</li>
</ul>
<h2>Version 0.1.2</h2>
<p>:Date: May 11, 2022</p>
<ul>
<li><code>@ericholscher
&lt;https://github.com/ericholscher&gt;</code><strong>: Improve SEO of
README &amp; docs index
(<code>[#111](readthedocs/readthedocs-sphinx-search#111)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/111&gt;</code></strong>)</li>
<li><code>@dependabot[bot]
&lt;https://github.com/dependabot[bot]&gt;</code><strong>: Bump moment
from 2.29.1 to 2.29.2
(<code>[#110](readthedocs/readthedocs-sphinx-search#110)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/110&gt;</code></strong>)</li>
<li><code>@stsewd &lt;https://github.com/stsewd&gt;</code><strong>: Test
with sphinx 4 and python 3.10
(<code>[#109](readthedocs/readthedocs-sphinx-search#109)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/109&gt;</code></strong>)</li>
<li><code>@stsewd &lt;https://github.com/stsewd&gt;</code><strong>: Add
sphinx metadata
(<code>[#108](readthedocs/readthedocs-sphinx-search#108)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/108&gt;</code></strong>)</li>
<li><code>@dependabot[bot]
&lt;https://github.com/dependabot[bot]&gt;</code><strong>: Bump minimist
from 1.2.5 to 1.2.6
(<code>[#107](readthedocs/readthedocs-sphinx-search#107)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/107&gt;</code></strong>)</li>
<li><code>@stsewd &lt;https://github.com/stsewd&gt;</code><strong>:
Rename master -&gt; main
(<code>[#106](readthedocs/readthedocs-sphinx-search#106)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/106&gt;</code></strong>)</li>
<li><code>@stsewd &lt;https://github.com/stsewd&gt;</code><strong>:
Docs: use sphinx 4.x
(<code>[#105](readthedocs/readthedocs-sphinx-search#105)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/105&gt;</code></strong>)</li>
<li><code>@astrojuanlu
&lt;https://github.com/astrojuanlu&gt;</code><strong>: Fix docs
(<code>[#102](readthedocs/readthedocs-sphinx-search#102)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/102&gt;</code></strong>)</li>
<li><code>@dependabot[bot]
&lt;https://github.com/dependabot[bot]&gt;</code><strong>: Bump postcss
from 7.0.35 to 7.0.39
(<code>[#100](readthedocs/readthedocs-sphinx-search#100)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/100&gt;</code></strong>)</li>
<li><code>@dependabot[bot]
&lt;https://github.com/dependabot[bot]&gt;</code><strong>: Bump
path-parse from 1.0.6 to 1.0.7
(<code>[#99](readthedocs/readthedocs-sphinx-search#99)
&lt;https://github.com/readthedocs/readthedocs-sphinx-search/pull/99&gt;</code></strong>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/c485b81f6015e4867bb01e600d031dc402500b39"><code>c485b81</code></a>
Release 0.3.2</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/8c6f6d01e88e72ef32ed0c220b6c19d1e1121c73"><code>8c6f6d0</code></a>
Merge pull request from GHSA-xgfm-fjx6-62mj</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/1608743622df0883b785a2ce07c587f146f2102b"><code>1608743</code></a>
Release 0.3.1 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/136">#136</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/25673a35b661a6a5dbc82d26c44998028dd61cc0"><code>25673a3</code></a>
Release 0.3.0 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/135">#135</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/ca36a1566296fe79926e838d9771ec0b7a1a27a8"><code>ca36a15</code></a>
Use API V3 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/132">#132</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/c8cb91264db65ff64f93d9cdf95eec75159f2ea1"><code>c8cb912</code></a>
Release 0.2.0 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/128">#128</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/5432999e4689970f22275c833aa65e41e4f8b1e3"><code>5432999</code></a>
CI: fix tests (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/127">#127</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/fa7e607f98bd697f9b4b6af6d3cd7de6d5e39117"><code>fa7e607</code></a>
Bump decode-uri-component from 0.2.0 to 0.2.2 (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/120">#120</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/225353f6be04f2fa178ec2350e3c27599b6b2ea1"><code>225353f</code></a>
Refactor: don't depend on underscore.js (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/116">#116</a>)</li>
<li><a
href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/5880a64bc514fef99a083c40f2dadc3e939cdc88"><code>5880a64</code></a>
Remove usage of jquery (<a
href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/115">#115</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/readthedocs/readthedocs-sphinx-search/compare/0.1.1...0.3.2">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=readthedocs-sphinx-search&package-manager=pip&previous-version=0.1.1&new-version=0.3.2)](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)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/MIT-LCP/wfdb-python/network/alerts).

</details>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet