mirror of https://github.com/pyodide/pyodide.git
DOC update to sphinx book theme (#1250)
This commit is contained in:
Roman Yurchak
GitHub
parent
ad611d608d
commit
444e11f416
|
|
@ -39,7 +39,7 @@ jobs:
|
|||
command: python3 -m sphinx -M html docs docs/_build
|
||||
|
||||
- store_artifacts:
|
||||
path: /root/repo/docs/_build/
|
||||
path: /home/circleci/repo/docs/_build/
|
||||
|
||||
build-core:
|
||||
<<: *defaults
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.6 KiB |
20
docs/conf.py
20
docs/conf.py
|
|
@ -14,6 +14,7 @@
|
|||
#
|
||||
import os
|
||||
import sys
|
||||
from typing import Dict, Any
|
||||
|
||||
for base_path in [".", ".."]:
|
||||
sys.path.insert(0, os.path.abspath(base_path))
|
||||
|
|
@ -52,6 +53,8 @@ extensions = [
|
|||
"sphinx_js",
|
||||
]
|
||||
|
||||
myst_enable_extensions = ["substitution"]
|
||||
|
||||
js_source_path = "../src/"
|
||||
|
||||
autosummary_generate = True
|
||||
|
|
@ -90,20 +93,16 @@ pygments_style = None
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
# html_theme = "sphinx_rtd_theme"
|
||||
html_theme = "sphinx_book_theme"
|
||||
html_logo = "_static/img/pyodide-logo.png"
|
||||
html_title = f"Version {version}"
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
html_theme_options = {
|
||||
"display_version": True,
|
||||
"prev_next_buttons_location": "bottom",
|
||||
# Toc options
|
||||
"collapse_navigation": True,
|
||||
"sticky_navigation": True,
|
||||
"navigation_depth": 2,
|
||||
}
|
||||
|
||||
html_theme_options: Dict[str, Any] = {}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
|
|
@ -120,7 +119,6 @@ html_static_path = ["_static"]
|
|||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
|
|
@ -1,10 +1,19 @@
|
|||
---
|
||||
substitutions:
|
||||
API: "<span class='badge badge-warning'>API Change</span>"
|
||||
Enhancement : "<span class='badge badge-info'>Enhancement</span>"
|
||||
Feature : "<span class='badge badge-success'>Feature</span>"
|
||||
Fix : "<span class='badge badge-danger'>Fix</span>"
|
||||
---
|
||||
|
||||
|
||||
(changelog)=
|
||||
# Release notes
|
||||
|
||||
## Version [Unreleased]
|
||||
### Breaking changes
|
||||
|
||||
- Removed iodide-specific code in `pyodide.js`. This breaks compatibility with
|
||||
- {{ API }} Removed iodide-specific code in `pyodide.js`. This breaks compatibility with
|
||||
iodide.
|
||||
[#878](https://github.com/iodide-project/pyodide/pull/878),
|
||||
[#981](https://github.com/iodide-project/pyodide/pull/981)
|
||||
|
|
@ -20,9 +29,9 @@
|
|||
need to be loaded explicitly
|
||||
[#1010](https://github.com/iodide-project/pyodide/pull/1010),
|
||||
[#987](https://github.com/iodide-project/pyodide/pull/987).
|
||||
- Removed the `pyodide.autocomplete` API, use Jedi directly instead.
|
||||
- {{ API }} Removed the `pyodide.autocomplete` API, use Jedi directly instead.
|
||||
[#1066](https://github.com/iodide-project/pyodide/pull/1066)
|
||||
- Removed repr API.
|
||||
- {{ API }} Removed repr API.
|
||||
[#1067](https://github.com/iodide-project/pyodide/pull/1067)
|
||||
- If `messageCallback` and `errorCallback` are supplied to
|
||||
`pyodide.loadPackage`, `pyodide.runPythonAsync` and
|
||||
|
|
@ -34,22 +43,22 @@
|
|||
[#1167](https://github.com/iodide-project/pyodide/pull/1167)
|
||||
|
||||
### Added
|
||||
- `micropip` now supports installing wheels from relative urls.
|
||||
- {{ Feature }} `micropip` now supports installing wheels from relative urls.
|
||||
[#872](https://github.com/iodide-project/pyodide/pull/872)
|
||||
- uglifyjs and lessc no longer need to be installed in the system during build
|
||||
[#878](https://github.com/iodide-project/pyodide/pull/878).
|
||||
- Reduce the size of the core pyodide package
|
||||
- {{ Enhancement }} Reduce the size of the core pyodide package
|
||||
[#987](https://github.com/iodide-project/pyodide/pull/987).
|
||||
- Updated packages: bleach 3.2.1, packaging 20.8
|
||||
- `eval_code` now accepts separate `globals` and `locals` parameters.
|
||||
[#1083](https://github.com/iodide-project/pyodide/pull/1083)
|
||||
- An InteractiveConsole with completion support to ease the integration
|
||||
of Pyodide REPL in webpages (used in console.html)
|
||||
[#1125](https://github.com/iodide-project/pyodide/pull/1125) and
|
||||
of Pyodide REPL in webpages (used in console.html)
|
||||
[#1125](https://github.com/iodide-project/pyodide/pull/1125) and
|
||||
[#1155](https://github.com/iodide-project/pyodide/pull/1155)
|
||||
- Flexible jsimports: it now possible to add custom Python "packages" backed by
|
||||
Javascript code, like the js package. The js package is now implemented
|
||||
using this system.
|
||||
using this system.
|
||||
[#1146](https://github.com/iodide-project/pyodide/pull/1146)
|
||||
- Added the `pyodide.setInterruptBuffer` API. This can be used to set a
|
||||
`SharedArrayBuffer` to be the keyboard interupt buffer. If Pyodide is running
|
||||
|
|
@ -57,9 +66,12 @@
|
|||
raise a `KeyboardInterrupt` by writing to the interrupt buffer.
|
||||
[#1148](https://github.com/iodide-project/pyodide/pull/1148) and
|
||||
[#1173](https://github.com/iodide-project/pyodide/pull/1173)
|
||||
- Added a Python event loop to support asyncio by scheduling coroutines to run
|
||||
as jobs on the browser event loop. This event loop is available by default and
|
||||
automatically enabled by any relevant asyncio API, so for instance
|
||||
- A `JsProxy` of a Javascript `Promise` or other awaitable object is now a
|
||||
Python awaitable.
|
||||
[#880](https://github.com/iodide-project/pyodide/pull/880)
|
||||
- Added a Python event loop to support asyncio by scheduling coroutines to run
|
||||
as jobs on the browser event loop. This event loop is available by default and
|
||||
automatically enabled by any relevant asyncio API, so for instance
|
||||
`asyncio.ensure_future` works without any configuration.
|
||||
[#1158](https://github.com/iodide-project/pyodide/pull/1158)
|
||||
- A `PyProxy` of a Python coroutine or awaitable is now an awaitable javascript
|
||||
|
|
@ -78,7 +90,7 @@
|
|||
[#1180](https://github.com/iodide-project/pyodide/pull/1180)
|
||||
|
||||
### Fixed
|
||||
- getattr and dir on JsProxy now report consistent results and include all
|
||||
- {{ Fix }} getattr and dir on JsProxy now report consistent results and include all
|
||||
names defined on the Python dictionary backing JsProxy.
|
||||
[#1017](https://github.com/iodide-project/pyodide/pull/1017)
|
||||
- `JsProxy.__bool__` now produces more consistent results: both `bool(window)`
|
||||
|
|
@ -129,7 +141,7 @@ by 0.16.1 with identical contents.
|
|||
- ENH Patches for the threading module were removed in all packages. Importing
|
||||
the module, and a subset of functionality (e.g. locks) works, while starting
|
||||
a new thread will produce an exception, as expected.
|
||||
[#796](https://github.com/iodide-project/pyodide/pull/796).
|
||||
[#796](https://github.com/iodide-project/pyodide/pull/796).
|
||||
See [#237](https://github.com/iodide-project/pyodide/pull/237) for the current
|
||||
status of the threading support.
|
||||
- ENH The multiprocessing module is now included, and will not fail at import,
|
||||
|
|
@ -237,11 +249,11 @@ Sergio, Seungmin Kim, Shyam Saladi, smkm, Wei Ouyang
|
|||
- Adds support for installing pure Python wheels from arbitrary URLs with
|
||||
micropip.
|
||||
- The CDN URL for pyodide changed to
|
||||
https://pyodide-cdn2.iodide.io/v0.15.0/full/pyodide.js
|
||||
It now supports versioning and should provide faster downloads.
|
||||
The latest release can be accessed via
|
||||
https://pyodide-cdn2.iodide.io/v0.15.0/full/pyodide.js
|
||||
It now supports versioning and should provide faster downloads.
|
||||
The latest release can be accessed via
|
||||
https://pyodide-cdn2.iodide.io/latest/full/
|
||||
- Adds `messageCallback` and `errorCallback` to
|
||||
- Adds `messageCallback` and `errorCallback` to
|
||||
{any}`pyodide.loadPackage`.
|
||||
- Reduces the initial memory footprint (`TOTAL_MEMORY`) from 1 GiB to 5 MiB.
|
||||
More memory will be allocated as needed.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
sphinx
|
||||
sphinx_rtd_theme
|
||||
# Pin while https://github.com/executablebooks/MyST-Parser/issues/299 is resolved for the 0.13.2 release
|
||||
myst-parser==0.13.1
|
||||
sphinx_book_theme
|
||||
myst-parser==0.13.3
|
||||
sphinxcontrib-napoleon
|
||||
distlib # required by micropip
|
||||
sphinx-js==3.1
|
||||
sphinx-js==3.1
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ if platform.system() == "Emscripten":
|
|||
asyncio.set_event_loop_policy(WebLoopPolicy())
|
||||
|
||||
|
||||
__version__ = "0.16.1"
|
||||
__version__ = "0.17.dev0"
|
||||
|
||||
__all__ = [
|
||||
"open_url",
|
||||
|
|
|
|||
Loading…
Reference in New Issue