From 325724b34929e5a91b23076c86102058ad1f9520 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Wed, 29 Mar 2023 16:55:43 +0200 Subject: [PATCH 1/5] Remove api/index.html --- docs/source/api/index.html | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 docs/source/api/index.html diff --git a/docs/source/api/index.html b/docs/source/api/index.html deleted file mode 100644 index 8bed2e1..0000000 --- a/docs/source/api/index.html +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - Welcome to Jupyter YDoc’s documentation! - - - From 90aa0b6cd9dccbe89995af26a737cdcd1b96ec8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Wed, 29 Mar 2023 17:07:49 +0200 Subject: [PATCH 2/5] Fix Python API doc & improve JavaScript API doc --- .gitignore | 2 + docs/source/changelog.md | 318 ------------------------------------- docs/source/conf.py | 23 +-- docs/source/python_api.rst | 18 ++- javascript/package.json | 4 +- javascript/typedoc.json | 50 +++++- 6 files changed, 78 insertions(+), 337 deletions(-) delete mode 100644 docs/source/changelog.md diff --git a/.gitignore b/.gitignore index 7ba392a..e89f2bf 100644 --- a/.gitignore +++ b/.gitignore @@ -145,3 +145,5 @@ jupyter_ydoc/_version.py !.yarn/releases !.yarn/sdks !.yarn/versions +docs/source/api +docs/source/changelog.md diff --git a/docs/source/changelog.md b/docs/source/changelog.md deleted file mode 100644 index 2aadb74..0000000 --- a/docs/source/changelog.md +++ /dev/null @@ -1,318 +0,0 @@ -# Changelog - - - -## 0.3.0a1 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.3.0a0...6dcc9ec61f4b022ec43bdaa7916bd58de481c761)) - -### Enhancements made - -- Add path document attribute [#81](https://github.com/jupyter-server/jupyter_ydoc/pull/81) ([@davidbrochart](https://github.com/davidbrochart)) -- Make YBaseDoc an abstract base class [#74](https://github.com/jupyter-server/jupyter_ydoc/pull/74) ([@davidbrochart](https://github.com/davidbrochart)) - -### Bugs fixed - -- Removes YMap for attachements [#77](https://github.com/jupyter-server/jupyter_ydoc/pull/77) ([@fcollonval](https://github.com/fcollonval)) -- Drop `pkg_resources` [#59](https://github.com/jupyter-server/jupyter_ydoc/pull/59) ([@jtpio](https://github.com/jtpio)) - -### Maintenance and upkeep improvements - -- Bump tj-actions/changed-files from 31.0.3 to 33.0.0 [#80](https://github.com/jupyter-server/jupyter_ydoc/pull/80) ([@dependabot](https://github.com/dependabot)) -- Bump pre-commit/action from 2.0.0 to 3.0.0 [#72](https://github.com/jupyter-server/jupyter_ydoc/pull/72) ([@dependabot](https://github.com/dependabot)) -- Bump actions/checkout from 2 to 3 [#71](https://github.com/jupyter-server/jupyter_ydoc/pull/71) ([@dependabot](https://github.com/dependabot)) -- Bump actions/setup-python from 2 to 4 [#70](https://github.com/jupyter-server/jupyter_ydoc/pull/70) ([@dependabot](https://github.com/dependabot)) -- Bump actions/cache from 1 to 3 [#69](https://github.com/jupyter-server/jupyter_ydoc/pull/69) ([@dependabot](https://github.com/dependabot)) -- Bump actions/setup-node from 2 to 3 [#68](https://github.com/jupyter-server/jupyter_ydoc/pull/68) ([@dependabot](https://github.com/dependabot)) -- Bump tj-actions/changed-files from 31.0.1 to 31.0.3 [#67](https://github.com/jupyter-server/jupyter_ydoc/pull/67) ([@dependabot](https://github.com/dependabot)) - -### Other merged PRs - -- Add workflows to ease maintenance [#64](https://github.com/jupyter-server/jupyter_ydoc/pull/64) ([@fcollonval](https://github.com/fcollonval)) -- Test a case with plotly renderer [#63](https://github.com/jupyter-server/jupyter_ydoc/pull/63) ([@fcollonval](https://github.com/fcollonval)) -- Pin @jupyterlab/shared-models >=4.0.0-alpha.10,\<4.0.0-alpha.14 [#61](https://github.com/jupyter-server/jupyter_ydoc/pull/61) ([@davidbrochart](https://github.com/davidbrochart)) -- Cast only if number has same value [#57](https://github.com/jupyter-server/jupyter_ydoc/pull/57) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-09-26&to=2022-10-26&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-09-26..2022-10-26&type=Issues) | [@dependabot](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adependabot+updated%3A2022-09-26..2022-10-26&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Afcollonval+updated%3A2022-09-26..2022-10-26&type=Issues) | [@jtpio](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ajtpio+updated%3A2022-09-26..2022-10-26&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2022-09-26..2022-10-26&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Awelcome+updated%3A2022-09-26..2022-10-26&type=Issues) - - - -## 0.3.0a0 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.2.0...63af4d7c91f1ba101612f0e52c24855a21eafedc)) - -### Merged PRs - -- Add back YMap for cell metadata [#53](https://github.com/jupyter-server/jupyter_ydoc/pull/53) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-09-26&to=2022-09-26&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-09-26..2022-09-26&type=Issues) - -## 0.2.0 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.17...55dc65afafb669d0a5552e485cf860d402740dc7)) - -### Merged PRs - -- Use hatch [#51](https://github.com/jupyter-server/jupyter_ydoc/pull/51) ([@davidbrochart](https://github.com/davidbrochart)) -- Removes YMap for cell metadata [#50](https://github.com/jupyter-server/jupyter_ydoc/pull/50) ([@hbcarlos](https://github.com/hbcarlos)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-08-01&to=2022-09-26&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-08-01..2022-09-26&type=Issues) | [@hbcarlos](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ahbcarlos+updated%3A2022-08-01..2022-09-26&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2022-08-01..2022-09-26&type=Issues) - -## 0.1.17 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.16...106ee079e2ad9ed7c8b25693932ad921e3ea3e20)) - -### Merged PRs - -- Handle missing attachment key [#43](https://github.com/jupyter-server/jupyter_ydoc/pull/43) ([@jimgoo](https://github.com/jimgoo)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-07-27&to=2022-08-01&type=c)) - -[@jimgoo](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ajimgoo+updated%3A2022-07-27..2022-08-01&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Awelcome+updated%3A2022-07-27..2022-08-01&type=Issues) - -## 0.1.16 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.15...780f8b8e898e31b6e82017a2bc2d04475728890f)) - -### Merged PRs - -- Move ypy-websocket dependency to test [#41](https://github.com/jupyter-server/jupyter_ydoc/pull/41) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-07-27&to=2022-07-27&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-07-27..2022-07-27&type=Issues) - -## 0.1.15 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.14...41a1ad194b5cd26dc405ef9d774c05dde494a489)) - -### Merged PRs - -- Add YNotebook get_cell, set_cell, append_cell [#35](https://github.com/jupyter-server/jupyter_ydoc/pull/35) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-07-26&to=2022-07-27&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-07-26..2022-07-27&type=Issues) - -## 0.1.14 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.13...523dc9e3ff9aed516ff0b0e3f2f7528f6da02faa)) - -### Merged PRs - -- Align notebook schema with JupyterLab HEAD [#38](https://github.com/jupyter-server/jupyter_ydoc/pull/38) ([@davidbrochart](https://github.com/davidbrochart)) -- [pre-commit.ci] pre-commit autoupdate [#37](https://github.com/jupyter-server/jupyter_ydoc/pull/37) ([@pre-commit-ci](https://github.com/pre-commit-ci)) -- [pre-commit.ci] pre-commit autoupdate [#36](https://github.com/jupyter-server/jupyter_ydoc/pull/36) ([@pre-commit-ci](https://github.com/pre-commit-ci)) -- [pre-commit.ci] pre-commit autoupdate [#28](https://github.com/jupyter-server/jupyter_ydoc/pull/28) ([@pre-commit-ci](https://github.com/pre-commit-ci)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-07-04&to=2022-07-26&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-07-04..2022-07-26&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2022-07-04..2022-07-26&type=Issues) - -## 0.1.13 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.12...807dc511e2d3536c62d0710d2b97a21c6e704337)) - -### Merged PRs - -- Update API [#32](https://github.com/jupyter-server/jupyter_ydoc/pull/32) ([@hbcarlos](https://github.com/hbcarlos)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-06-30&to=2022-07-04&type=c)) - -[@hbcarlos](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ahbcarlos+updated%3A2022-06-30..2022-07-04&type=Issues) - -## 0.1.12 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.11...05c97a4b32b826f7c5224d8807340314a7df832d)) - -### Merged PRs - -- Fix type checking when casting [#30](https://github.com/jupyter-server/jupyter_ydoc/pull/30) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-06-09&to=2022-06-30&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-06-09..2022-06-30&type=Issues) - -## 0.1.11 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.10...9329161e338ac999a1c342bce89bf4f642b426aa)) - -### Merged PRs - -- Changes the schema [#27](https://github.com/jupyter-server/jupyter_ydoc/pull/27) ([@hbcarlos](https://github.com/hbcarlos)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-19&to=2022-06-09&type=c)) - -[@hbcarlos](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ahbcarlos+updated%3A2022-05-19..2022-06-09&type=Issues) - -## 0.1.10 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.9...142953275358ce675203d3de479cf8f2a4413fe8)) - -### Merged PRs - -- Remove document apply_update method [#25](https://github.com/jupyter-server/jupyter_ydoc/pull/25) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-19&to=2022-05-19&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-19..2022-05-19&type=Issues) - -## 0.1.9 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.8...4654f6176af5c6f26f18646283e9eec16b1f013f)) - -### Merged PRs - -- Add document apply_update method [#23](https://github.com/jupyter-server/jupyter_ydoc/pull/23) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-12&to=2022-05-19&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-12..2022-05-19&type=Issues) - -## 0.1.8 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.7...3662d97fadde04e70dd599523666f2716dcd14de)) - -### Merged PRs - -- Move nbformat and nbformat_minor to meta YMap [#21](https://github.com/jupyter-server/jupyter_ydoc/pull/21) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-11&to=2022-05-12&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-11..2022-05-12&type=Issues) | [@hbcarlos](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ahbcarlos+updated%3A2022-05-11..2022-05-12&type=Issues) - -## 0.1.7 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.6...b382a35a052da5b99c94d9bedaaa92634b5d1fb4)) - -### Merged PRs - -- Also observe the state YMap [#19](https://github.com/jupyter-server/jupyter_ydoc/pull/19) ([@davidbrochart](https://github.com/davidbrochart)) -- Change URL to point to jupyter-server [#18](https://github.com/jupyter-server/jupyter_ydoc/pull/18) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-11&to=2022-05-11&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-11..2022-05-11&type=Issues) - -## 0.1.6 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.5...09cf7997439a7ca2a36041390a4e93984277a36c)) - -### Merged PRs - -- Allow to set dirty whatever the previous value [#16](https://github.com/jupyter-server/jupyter_ydoc/pull/16) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-10&to=2022-05-11&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-10..2022-05-11&type=Issues) - -## 0.1.5 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.4...5b36f6bed6c4d5a789b9dd7b06a526889e515511)) - -### Merged PRs - -- Adds id to cells [#13](https://github.com/jupyter-server/jupyter_ydoc/pull/13) ([@hbcarlos](https://github.com/hbcarlos)) -- [pre-commit.ci] pre-commit autoupdate [#12](https://github.com/jupyter-server/jupyter_ydoc/pull/12) ([@pre-commit-ci](https://github.com/pre-commit-ci)) -- Transfer repo to jupyter-server org [#11](https://github.com/jupyter-server/jupyter_ydoc/pull/11) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-09&to=2022-05-10&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-09..2022-05-10&type=Issues) | [@hbcarlos](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Ahbcarlos+updated%3A2022-05-09..2022-05-10&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2022-05-09..2022-05-10&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Awelcome+updated%3A2022-05-09..2022-05-10&type=Issues) - -## 0.1.4 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.3...d6e754a8c957582029d923cadc4e6547a324718c)) - -### Merged PRs - -- Update ypy>=0.5.0 [#9](https://github.com/jupyter-server/jupyter_ydoc/pull/9) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-05&to=2022-05-09&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-05..2022-05-09&type=Issues) - -## 0.1.3 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.2...c68ebe54e500edde4eb34aa598dfb7bbb4d22b63)) - -### Merged PRs - -- Add setuptools to install_requires [#7](https://github.com/jupyter-server/jupyter_ydoc/pull/7) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-05&to=2022-05-05&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-05..2022-05-05&type=Issues) - -## 0.1.2 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/v0.1.1...6a1fc44531344e1f930a7fd52b62cbd289873be0)) - -### Merged PRs - -- Improve jupyter_ydoc.ydocs [#5](https://github.com/jupyter-server/jupyter_ydoc/pull/5) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-04&to=2022-05-05&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-04..2022-05-05&type=Issues) - -## 0.1.1 - -([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/0.1.0...9db91b826c38116ab1e00b26140dd49950e1a793)) - -### Merged PRs - -- Add test [#3](https://github.com/jupyter-server/jupyter_ydoc/pull/3) ([@davidbrochart](https://github.com/davidbrochart)) -- Update README [#1](https://github.com/jupyter-server/jupyter_ydoc/pull/1) ([@davidbrochart](https://github.com/davidbrochart)) - -### Contributors to this release - -([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2022-05-02&to=2022-05-04&type=c)) - -[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2022-05-02..2022-05-04&type=Issues) - -## 0.1.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e5603e..9cf6687 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -84,21 +84,14 @@ def setup(app): # Build JavaScript Docs js = HERE.parent.parent / "javascript" - js_docs = js / "docs" dest_dir = Path(app.outdir) / "api" - if js_docs.exists(): - # avoid rebuilding docs because it takes forever - # `make clean` to force a rebuild - print(f"already have {js_docs!s}") - else: - print("Building jupyterlab API docs") - check_call(["npm", "install"], cwd=str(js)) - check_call(["npm", "run", "build"], cwd=str(js)) - check_call(["npm", "run", "docs"], cwd=str(js)) - - # Copy JavaScript Docs - print(f"Copying {js_docs!s} -> {dest_dir!s}") + print("Building @jupyter/ydoc API docs") + cmd = ["yarn"] if shutil.which("yarn") is not None else ["npm"] + check_call(cmd + ["install"], cwd=str(js)) + check_call(cmd + ["run", "build"], cwd=str(js)) + check_call(cmd + ["run", "docs"], cwd=str(js)) + if dest_dir.exists(): - shutil.rmtree(str(dest_dir)) - shutil.copytree(str(js_docs), str(dest_dir)) + shutil.rmtree(dest_dir) + shutil.copytree(str(js / "docs"), str(dest_dir)) diff --git a/docs/source/python_api.rst b/docs/source/python_api.rst index 1d0662a..1d28005 100644 --- a/docs/source/python_api.rst +++ b/docs/source/python_api.rst @@ -4,6 +4,22 @@ Python API ========== -.. automodule:: jupyter_ydoc.ydoc +.. automodule:: jupyter_ydoc.ybasedoc + :members: + :inherited-members: + +.. automodule:: jupyter_ydoc.yblob + :members: + :inherited-members: + +.. automodule:: jupyter_ydoc.yfile + :members: + :inherited-members: + +.. automodule:: jupyter_ydoc.ynotebook + :members: + :inherited-members: + +.. automodule:: jupyter_ydoc.yunicode :members: :inherited-members: diff --git a/javascript/package.json b/javascript/package.json index 226d163..0867c47 100644 --- a/javascript/package.json +++ b/javascript/package.json @@ -24,8 +24,8 @@ "scripts": { "build": "tsc -b", "build:test": "tsc --build tsconfig.test.json", - "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo", - "docs": "typedoc --out ./docs src", + "clean": "rimraf lib tsconfig.tsbuildinfo docs", + "docs": "typedoc src", "eslint": "eslint --ext .js,.jsx,.ts,.tsx --cache --fix .", "eslint:check": "eslint --ext .js,.jsx,.ts,.tsx --cache .", "lint": "yarn integrity && yarn prettier && yarn eslint", diff --git a/javascript/typedoc.json b/javascript/typedoc.json index d8de595..0bc50de 100644 --- a/javascript/typedoc.json +++ b/javascript/typedoc.json @@ -1,3 +1,51 @@ { - "out": "../docs/api/shared-models" + "externalSymbolLinkMappings": { + "@jupyterlab/nbformat": { + "CellType": "https://jupyterlab.readthedocs.io/en/latest/api/types/nbformat.CellType.html", + "ExecutionCount": "https://jupyterlab.readthedocs.io/en/latest/api/types/nbformat.ExecutionCount.html", + "IAttachments": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IAttachments.html", + "IBaseCell": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IBaseCell.html", + "IBaseCellMetadata": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IBaseCellMetadata.html", + "ICodeCell": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.ICodeCell.html", + "IMarkdownCell": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IMarkdownCell.html", + "INotebookContent": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.INotebookContent.html", + "INotebookMetadata": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.INotebookMetadata.html", + "IOutput": "https://jupyterlab.readthedocs.io/en/latest/api/types/nbformat.IOutput.html", + "IRawCell": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IRawCell.html", + "IUnrecognizedCell": "https://jupyterlab.readthedocs.io/en/latest/api/interfaces/nbformat.IUnrecognizedCell.html" + }, + "@lumino/coreutils": { + "JSONObject": "https://lumino.readthedocs.io/en/latest/api/interfaces/coreutils.JSONObject.html", + "JSONValue": "https://lumino.readthedocs.io/en/latest/api/types/coreutils.JSONValue.html", + "PartialJSONValue": "https://lumino.readthedocs.io/en/latest/api/types/coreutils.PartialJSONValue.html" + }, + "@lumino/disposable": { + "IObservableDisposable": "https://lumino.readthedocs.io/en/latest/api/interfaces/disposable.IObservableDisposable.html" + }, + "@lumino/signaling": { + "ISignal": "https://lumino.readthedocs.io/en/latest/api/interfaces/signaling.ISignal.html", + "Signal": "https://lumino.readthedocs.io/en/latest/api/classes/signaling.Signal-1.html", + }, + "y-protocols": { + "Awareness": "https://docs.yjs.dev/api/about-awareness" + }, + "yjs": { + "Array": "https://docs.yjs.dev/api/shared-types/y.array", + "Doc": "https://docs.yjs.dev/api/y.doc", + "Map": "https://docs.yjs.dev/api/shared-types/y.map", + "Text": "https://docs.yjs.dev/api/shared-types/y.text", + "UndoManager": "https://docs.yjs.dev/api/undo-manager", + "YArrayEvent": "https://docs.yjs.dev/api/shared-types/y.array#y.arrayevent-api", + "YEvent": "https://docs.yjs.dev/api/y.event", + "YMapEvent": "https://docs.yjs.dev/api/shared-types/y.map#y.mapevent-api", + "YTextEvent": "https://docs.yjs.dev/api/shared-types/y.text#y.textevent-api" + } + }, + "githubPages": false, + "navigationLinks": { + "GitHub": "https://github.com/jupyter-server/jupyter_ydoc", + "Jupyter": "https://jupyter.org" + }, + "titleLink": "https://jupyter-ydoc.readthedocs.io/en/latest", + "out": "./docs" } From b35fe141dce35d0ab58b5211ee4550804fb15828 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Wed, 29 Mar 2023 12:53:09 -0400 Subject: [PATCH 3/5] Ignore link to transient file --- .github/workflows/check-release.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml index 0f88615..776a91d 100644 --- a/.github/workflows/check-release.yml +++ b/.github/workflows/check-release.yml @@ -27,6 +27,8 @@ jobs: - name: Check Links if: ${{ matrix.group == 'link_check' }} uses: jupyter-server/jupyter_releaser/.github/actions/check-links@v1 + with: + ignore_links: "./api/*.*" - name: Check Release if: ${{ matrix.group == 'check_release' }} uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2 From 0542976c57c83c857dcac568eed2805a7f3cbe8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Wed, 29 Mar 2023 13:03:34 -0400 Subject: [PATCH 4/5] more check link fix --- .github/workflows/check-release.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml index 776a91d..21f0cea 100644 --- a/.github/workflows/check-release.yml +++ b/.github/workflows/check-release.yml @@ -12,6 +12,7 @@ jobs: check_release: runs-on: ubuntu-latest strategy: + fail-fast: false matrix: group: [check_release, link_check] python-version: ["3.9"] @@ -28,7 +29,7 @@ jobs: if: ${{ matrix.group == 'link_check' }} uses: jupyter-server/jupyter_releaser/.github/actions/check-links@v1 with: - ignore_links: "./api/*.*" + ignore_links: "./api/index.html" - name: Check Release if: ${{ matrix.group == 'check_release' }} uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2 From 130d4a1897a4f906dfb32eb0bd99213fdfa44a7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Collonval?= Date: Wed, 29 Mar 2023 19:06:02 +0200 Subject: [PATCH 5/5] Prettify --- javascript/typedoc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/javascript/typedoc.json b/javascript/typedoc.json index 0bc50de..8d2c685 100644 --- a/javascript/typedoc.json +++ b/javascript/typedoc.json @@ -24,7 +24,7 @@ }, "@lumino/signaling": { "ISignal": "https://lumino.readthedocs.io/en/latest/api/interfaces/signaling.ISignal.html", - "Signal": "https://lumino.readthedocs.io/en/latest/api/classes/signaling.Signal-1.html", + "Signal": "https://lumino.readthedocs.io/en/latest/api/classes/signaling.Signal-1.html" }, "y-protocols": { "Awareness": "https://docs.yjs.dev/api/about-awareness"