Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit7963a79

Browse files
authored
Add documentation for contributing to the docs (jupyter#6771)
* Develop docs on Gitpod* Add documentation section to the contributing docs* Add a section for contributing from the browser* typo fix* fix link in contributing* Add Gitpod badge* fix auto activate
1 parentf05e5a9 commit7963a79

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

‎.gitpod.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,15 @@ tasks:
4343
echo "source /workspace/bin/activate-env.sh" >> ~/.bashrc
4444
source /workspace/bin/activate-env.sh
4545
46+
-name:docs
47+
command:|
48+
gp sync-await setup
49+
sudo apt-get update
50+
sudo apt install enchant-2 -y
51+
wget https://github.com/jgm/pandoc/releases/download/2.14.2/pandoc-2.14.2-1-amd64.deb -O /tmp/pandoc.deb && sudo dpkg -i /tmp/pandoc.deb
52+
source /workspace/bin/activate-env.sh
53+
hatch run docs:build
54+
hatch run docs:serve
55+
4656
ports:
4757
-port:8888

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,29 @@ automatically on save.
152152

153153
Some of the hooks only run on CI by default, but you can invoke them by
154154
running with the`--hook-stage manual` argument.
155+
156+
##Documentation
157+
158+
First make sure you have set up a development environment as described above.
159+
160+
Then run the following command to build the docs:
161+
162+
```shell
163+
hatch run docs:build
164+
```
165+
166+
In a separate terminal window, run the following command to serve the documentation:
167+
168+
```shell
169+
hatch run docs:serve
170+
```
171+
172+
Now open a web browser and navigate to`http://localhost:8000` to access the documentation.
173+
174+
##Contributing from the browser
175+
176+
Alternatively you can also contribute to Jupyter Notebook without setting up a local environment, directly from a web browser:
177+
178+
-[Gitpod](https://gitpod.io/#https://github.com/jupyter/notebook) integration is enabled. The Gitpod config automatically builds the Jupyter Notebook application and the documentation.
179+
- GitHub’s[built-in editor](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) is suitable for contributing small fixes
180+
- A more advanced[github.dev](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor) editor can be accessed by pressing the dot (.) key while in the Jupyter Notebook GitHub repository,

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
55
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/notebook/main?urlpath=tree)
66
[![codecov](https://codecov.io/gh/jupyter/notebook/branch/main/graph/badge.svg)](https://codecov.io/gh/jupyter/notebook)
7+
[![Gitpod](https://img.shields.io/badge/gitpod_editor-open-blue.svg)](https://gitpod.io/#https://github.com/jupyter/notebook)
78

89
The Jupyter notebook is a web-based notebook environment for interactive
910
computing.

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ include = ["/notebook"]
116116
features = ["docs"]
117117
[tool.hatch.envs.docs.scripts]
118118
build ="make -C docs html SPHINXOPTS='-W'"
119+
serve ="cd docs/build/html && python -m http.server"
119120

120121
[tool.hatch.envs.default.scripts]
121122
npm_pack ="jlpm lerna exec -- npm pack"

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp