-
Notifications
You must be signed in to change notification settings - Fork 325
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.
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
Update Contribution Page for Jupyter Server #1499
Conversation
9133eb2
to
f1b7315
Compare
e6bc218
to
5a2c922
Compare
159c3df
to
bacf845
Compare
9872c8a
to
bbd3be3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
:show-inheritance: | ||
:undoc-members: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the order make a difference here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about that, but the CI is generating the same changes, this was what failed the CI in previous commits. @kjayan Would help to check with others in the JupyterLab weekly call, before we merge.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Here's the failed API docs verification run: https://github.com/jupyter-server/jupyter_server/actions/runs/13475837186/job/37672436815
- To reproduce the error locally, checkout commit bbd3be3 (or any other commit before docs update) and run commands from the failed "Build API docs" CI step manually
jupyter_server/.github/workflows/python-tests.yml
Lines 65 to 72 in c67a46b
- name: Build API docs run: | hatch -v run docs:api # If this fails run `hatch run docs:api` locally # and commit. git status --porcelain git status -s | grep "A" && exit 1 git status -s | grep "M" && exit 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tagging @vidartf as discussed in the community call.
I reviewed this following the topic coming in to the Jupyter Frontends and Accessibility call. These looks like some great documentation improvements. |
The following updates are made to the contributing page .
sphinx
can happen. New instructions are added to install this packageand its related dependenciespip install hatch hatch run docs:build
to reflect it properlypip install ".[docs]"
andpip install ".[test]"