Skip to content

Commit 833ec62

Browse files
brichetgithub-actions[bot]jtpio
authored
Add documentation (#71)
* Add user documentation * Add contributors documentation * Add some user documentation * Automatic application of license header * Documentation about adding a chat in an extension * Add some documentation about integrating jupyterlab-collaborative-chat * Some corrections in the documentation * Minor typo fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jeremy Tuloup <[email protected]>
1 parent c655e67 commit 833ec62

22 files changed

+1030
-0
lines changed

.readthedocs.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.11"
10+
nodejs: "18"
11+
12+
# Build documentation in the docs/ directory with Sphinx
13+
sphinx:
14+
configuration: docs/source/conf.py
15+
16+
python:
17+
install:
18+
- method: pip
19+
path: .
20+
extra_requirements:
21+
- docs

docs/Makefile

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Copyright (c) Jupyter Development Team.
2+
# Distributed under the terms of the Modified BSD License.
3+
4+
# Minimal makefile for Sphinx documentation
5+
#
6+
7+
# You can set these variables from the command line, and also
8+
# from the environment for the first two.
9+
SPHINXOPTS ?=
10+
SPHINXBUILD ?= sphinx-build
11+
SOURCEDIR = source
12+
BUILDDIR = build
13+
14+
# Put it first so that "make" without argument is like "make help".
15+
help:
16+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
17+
18+
.PHONY: help Makefile
19+
20+
# Catch-all target: route all unknown targets to Sphinx using the new
21+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
22+
%: Makefile
23+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
rem Copyright (c) Jupyter Development Team.
2+
rem Distributed under the terms of the Modified BSD License.
3+
4+
@ECHO OFF
5+
6+
pushd %~dp0
7+
8+
REM Command file for Sphinx documentation
9+
10+
if "%SPHINXBUILD%" == "" (
11+
set SPHINXBUILD=sphinx-build
12+
)
13+
set SOURCEDIR=source
14+
set BUILDDIR=build
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.https://www.sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
if "%1" == "" goto help
30+
31+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
32+
goto end
33+
34+
:help
35+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
36+
37+
:end
38+
popd

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
myst-parser
3+
pydata_sphinx_theme
665 Bytes
Loading
680 Bytes
Loading
591 Bytes
Loading
524 Bytes
Loading
164 KB
Loading
1.86 KB
Loading

0 commit comments

Comments
 (0)