Comments (3)
We recently switched to redoc for the JupyterHub API on readthedocs: https://jupyterhub.readthedocs.io/en/latest/reference/rest-api.html
I think it looks quite nice! It works in the way you say- the HTML code is pretty minimal, it's javascript that fetches the openapi spec https://jupyterhub.readthedocs.io/en/latest/_static/rest-api.yml and renders it.
from jupyter_server.
Sure, can take a look at redoc
first. They kinda push the veal with their premium product, but if it does the job, and the open source variant isn't too crippled...
from jupyter_server.
#1419 is ready for review: a lot of author doubt in there, and open to ways forward, with a personal bias toward first-party extension and jupyter_server[apidocs]
shout-out from this repo (and placeholder content).
from jupyter_server.
Related Issues (20)
- Enable EPUB and HTML outputs from the docs HOT 1
- Tests failing in the latest version HOT 4
- Removing `nbconvert` as a required dependency HOT 4
- Missing Python target version bound leads to incorrect `ruff` suggestions HOT 3
- Kernel's execution state is not updated after the kernel is crashed while executing code HOT 4
- Should `current_user` and `prepare` guards be set in `AuthenticatedHandler` rather than `JupyterHandler`? HOT 2
- The Shut Down and Log Out menu items disappeared between 2.12.5 and 2.13.0 HOT 2
- Invalid page_config.json can crash server HOT 1
- interface for switching between jupyter apps
- Add constraints fore saving/reading files
- Slower atexit methods do not run to completion HOT 2
- Running Out of memory in a process can cause the extension handler to crash HOT 1
- Fix outdated security documentation HOT 3
- Cookie security docs are misleading
- extensions cannot render error pages without static_paths configuration HOT 1
- Environment variables passed to logs should be sanitised out of the logs
- Tests are failing on Windows HOT 1
- Pass session ID during Websocket Upgrade connection when using Gateway.
- jupyter server crashes and fails to render files or file ops if a malformed `pyproject.toml` is found in a user's homedir HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jupyter_server.