Skip to content

Conversation

ianthomas23
Copy link
Member

Add infrastructure for project docs using sphinx and myst.

To build docs:

cd docs
pip install -r requirements-docs.txt
make html

and the output is in the _build/html directory.

Currently doesn't build the terminal beforehand, but this may have to change if for example we need to extract API docs.

No content yet, and not yet building in CI.

@ianthomas23 ianthomas23 added the documentation Improvements or additions to documentation label Sep 22, 2025
Copy link

vercel bot commented Sep 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
jupyterlite-terminal Ready Ready Preview Comment Sep 25, 2025 2:44pm

@ianthomas23
Copy link
Member Author

Terminal deployment added to the sphinx build via jupyterlite-sphinx. To try this out locally first build the terminal extension (pip install -ve . for example) and then the docs (cd docs; make html), then serve the docs with the deployment via

cd _build/html
python -m http.server

There is a link from the first docs page to the deployment.

@ianthomas23
Copy link
Member Author

Read the docs build featuring docs and demo deployment succeeded, see https://jupyterlite-terminal--68.org.readthedocs.build/en/68/.

@ianthomas23 ianthomas23 merged commit 8e87d6c into main Sep 26, 2025
11 checks passed
@ianthomas23 ianthomas23 deleted the docs-setup branch September 26, 2025 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant