Commit Graph

39 Commits

Author SHA1 Message Date
Hood Chatham 4773c6cf73
Update docs to use latest sphinx-js version (#4742)
This pulls in the tip of the master branch of sphinx-js and shortens the
jsdoc.py patches by about 60 lines.

I also fixed some broken links and various typedoc and sphinx warnings.
I turned on nitpicky mode and silenced intentionally broken links so in the
future we can catch broken xrefs better. These warnings also help turn up
cases where private fields are accidentally included into the docs.
2024-05-07 12:40:33 +02:00
Hood Chatham 2988faf8d4
Use upstreamed autosummary and automodule directives (#4196) 2023-10-02 12:00:32 -07:00
Hood Chatham 2bcd48c4c2
Switch to using sphinx-js fork (#4193) 2023-09-30 16:41:02 -07:00
Roman Yurchak 0a1d87d45f
Customize build type in indexURL used by console.html (#3702)
[skip ci]
2023-03-29 22:06:59 +02:00
Arpit 42fa9939b0
Upgrades packaging version to v23.0 and micropip to 0.2.2 (#3605)
Co-authored-by: Roman Yurchak <rth.yurchak@gmail.com>
2023-03-04 21:45:23 +01:00
Gyeongjae Choi 71d466df2f
DOC Fix version warning CSS (#3533)
Close https://github.com/pyodide/pyodide/issues/3513
2023-02-04 14:49:11 +01:00
Hood Chatham 69d7b4e099
Remove napoleon_fixes (#3479)
I upstreamed all of this into sphinx-autodoc-typehints.
2023-01-21 17:44:20 -08:00
Hood Chatham eca4b1615e
Add sphinx-design, fix tabs (#3473)
In #3461 I dropped `sphinx-panels` but of course we *were* using it. It has a successor called
`sphinx-design` which works with sphinx 5.x (still not 6.x but we have several packages that cap 
sphinx <6). I also updated the use of the tabbed directive to the new sphinx-design api.
2023-01-17 22:35:30 -08:00
Hood Chatham 3cc6ac7873
Minor docs fixes (#3467)
Remove the property prefix from properties, add a link for ast.Module.

Previously this included more significant changes but they have been upstreamed into sphinx-autodoc-typehints.
2023-01-18 14:00:39 +09:00
Hood Chatham 4ff8687965
DOCS Fixes for shortcomings of napoleon (#3451)
I opened a PR for one of the Napoleon changes:
https://github.com/sphinx-doc/sphinx/pull/11131
But we use Sphinx v5.3 so even if we upstream Napoleon fixes into Sphinx v6.x, 
we won't get to use them for a while.
2023-01-16 19:59:07 -08:00
Hood Chatham e4421b94aa
Update docs requirements (#3461)
With this we can get up to Sphinx 5.3.0 (from Sphinx 4.5.0). I dropped sphinx-panels
since it has a version pin on Spinx < 5 (we don't seem to use it anyways). I moved to
sphinx-book-theme 0.4.0rc1 since version 0.3.0 pins Sphinx < 5. 

This is relevant because new versions of sphinx-autodoc-typehints require Sphinx>=5.3
so we can't pull in my fixes to sphinx-autodoc-typehints.

In the future, I would like for version caps (==, <, <=, and =~) to have comments
explaining them. I removed all the version caps since none of them seem to actively break.
In particular, we can now use jinja2 version 3 so we don't have to pin docutils 0.16.
2023-01-16 18:47:20 -08:00
Hood Chatham f55bb2e423
Cleanup of documentation configuration (#3448) 2023-01-14 15:01:20 +01:00
Hood Chatham b0b07efe94
Update to sphinx-js 3.2.1 (#3429) 2023-01-07 13:23:56 +02:00
Hood Chatham e90154f3e2
DOCS Use autodoc typehints and make various improvements to autodoc rendering (#3405)
Co-authored-by: Roman Yurchak <rth.yurchak@gmail.com>
2023-01-04 11:51:09 +02:00
Roman Yurchak fdbcc087e2
Add Pyodide CLI documentation (#3367)
Co-authored-by: Gyeongjae Choi <def6488@gmail.com>
2022-12-22 11:24:28 +01:00
Roman Yurchak 5f6ecca68d
Update to micropip v0.2.0 (#3347)
Co-authored-by: Gyeongjae Choi <def6488@gmail.com>
2022-12-14 09:11:19 +01:00
Roman Yurchak 0b4d73fa3e
Include micropip from a separate repository (#3122) 2022-09-24 13:02:17 +02:00
Roman Yurchak 4dd8a3e0cb
Switch to meta.yaml parsing with pydantic (#3079) 2022-09-11 09:20:56 +02:00
Hood Chatham 0e1e2ac01c
Python 3.10 (#2225) 2022-03-17 15:48:56 -07:00
Roman Yurchak c11fabc479
Fix pre-commit CI (#2191) 2022-02-19 09:33:49 +01:00
Gyeongjae Choi 1041e8ebee
Pin markupsafe version (#2183) 2022-02-18 07:55:33 -05:00
Gyeongjae Choi 039618988f
DOC Add version alert on latest docs (#2093) 2022-01-16 20:00:22 -08:00
Roman Yurchak cd1b0c2c24
DOC Improve build instructions [skip ci] (#1960)
Co-authored-by: Hood Chatham <roberthoodchatham@gmail.com>
Co-authored-by: Jan Max Meyer <jmm@phorward.de>
2021-11-15 17:22:24 +01:00
Hood Chatham f0bd568a31
Set up pytest node tests (#1717) 2021-07-20 10:48:27 +02:00
Hood Chatham 2ae0da3c45
DOCS Use sphinx-issues to link prs / issues [skip CI] (#1487) 2021-04-18 17:59:19 -07:00
Roman Yurchak cae11abf78
DOC Make dev documentation consistent + version warnings (#1479)
Co-authored-by: Hood Chatham <roberthoodchatham@gmail.com>
2021-04-17 19:18:52 +02:00
Roman Yurchak 4c1024545f
DOC Add pyodide_build CLI documentation (#1471) 2021-04-15 18:54:26 +02:00
Hood Chatham ea4527e2e0
Use packaging instead of distlib in micropip (#1469) 2021-04-14 20:15:31 +02:00
Hood Chatham d3a0410e4c
DOCS Pin docutils to v0.16 (#1430) 2021-04-03 18:21:04 -07:00
Hood Chatham ccd0f1335b
DOC Implement autosummary for js autodoc, use autodocsumm for py autodoc (#1354) 2021-03-22 09:39:09 +01:00
Roman Yurchak 444e11f416
DOC update to sphinx book theme (#1250) 2021-02-15 08:59:38 +01:00
Hood Chatham 19ebad28dc
DOC Use sphinx-js for pyodide_js documentation (#1197) 2021-02-06 21:17:57 +01:00
Roman Yurchak f9f01be97d
MAINT/CI Fix documentation CI (#1157) 2021-01-20 23:34:38 +01:00
Hood Chatham de700f0424
DOC Minor updates to docs configuration (#873) 2020-12-21 10:52:33 +01:00
Roman Yurchak 7d566f3b22 DOC/CI Fix missing requirement in readthedocs build 2020-10-31 21:29:11 +01:00
Roman Yurchak f1cc304717
DOC Refactor API reference documentation (#782) 2020-10-31 21:00:58 +01:00
Roman Yurchak a260ea3bbf
DOC Refactor instructions for loading packages (#781) 2020-10-31 10:02:23 +01:00
Roman Yurchak 60dd0589da CI Fix docs dependencies 2020-10-30 21:56:14 +01:00
Carol Willing 9f4dceb812 Adds Sphinx documentation build (#474)
* create proof of concept

* add rtd config file

* edit config

* minor edits in rst files

* update config from proof of concept to prod

* add a bit more explanation to contents page

* Label markdown block as js to prevent Sphinx warning

* correct links warning in Sphinx

* fix typo
2019-06-22 18:22:38 -04:00