Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation #71

Merged
merged 8 commits into from
Aug 14, 2024
Merged

Add documentation #71

merged 8 commits into from
Aug 14, 2024

Conversation

brichet
Copy link
Collaborator

@brichet brichet commented Aug 8, 2024

This PR includes documentation

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 8, 2024

Binder 👈 Launch a Binder on branch brichet/jupyter-chat/documentation

@brichet brichet added the documentation Improvements or additions to documentation label Aug 8, 2024
@brichet brichet marked this pull request as ready for review August 9, 2024 10:30
jtpio
jtpio reviewed Aug 13, 2024
View reviewed changes
docs/Makefile Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could drop the make files and use hatch scripts directly?

Something like the following in pyproject.toml:

[tool.hatch.envs.docs.scripts]
build = "sphinx-build -W -b html docs docs/build/html"
watch = "sphinx-autobuild -W -b html docs docs/build/html --host 0.0.0.0"
serve = "python -m http.server --directory docs/build/html"

jtpio
jtpio reviewed Aug 13, 2024
View reviewed changes
.readthedocs.yaml Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a jupyter-chat project on ReadTheDocs already?

Otherwise happy to create and invite you to have access on https://readthedocs.org.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just created a project on ReadTheDocs: https://jupyter-chat.readthedocs.io/en/latest/

jtpio
jtpio approved these changes Aug 14, 2024
View reviewed changes
Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Let's get this in and we can iterate more in follow-up PRs.

@jtpio jtpio merged commit 833ec62 into jupyterlab:main Aug 14, 2024
9 checks passed
@brichet brichet deleted the documentation branch August 27, 2024 06:26
@brichet brichet mentioned this pull request Sep 12, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jtpio jtpio jtpio approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brichet @jtpio