Skip to content

Commit ffdb4f3

Browse files
yuvipandayuvipanda
authored
Merge pull request jupyterhub#313 from consideRatio/pr/update-docs
Modernize docs without making changes to its content
2 parents 8ac2263 + 2af9e70 commit ffdb4f3

File tree

11 files changed

+292
-153
lines changed

11 files changed

+292
-153
lines changed

‎.github/workflows/linkcheck.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# This is a GitHub workflow defining a set of jobs with a set of steps. ref:
2+
# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
3+
#
4+
name: Linkcheck
5+
6+
on:
7+
pull_request:
8+
paths:
9+
- "docs/**"
10+
- "**/linkcheck.yaml"
11+
push:
12+
paths:
13+
- "docs/**"
14+
- "**/linkcheck.yaml"
15+
branches-ignore:
16+
- "dependabot/**"
17+
- "pre-commit-ci-update-config"
18+
workflow_dispatch:
19+
20+
jobs:
21+
linkcheck:
22+
runs-on: ubuntu-20.04
23+
steps:
24+
- uses: actions/checkout@v2
25+
- uses: actions/setup-python@v2
26+
with:
27+
python-version: "3.8"
28+
29+
- name: Install deps
30+
run: pip install -r docs/requirements.txt
31+
32+
- name: make linkcheck
33+
run: |
34+
cd docs
35+
make linkcheck SPHINXOPTS='--color -W --keep-going'

‎.gitignore‎

Lines changed: 146 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,149 @@
1-
.coverage*
2-
.ipynb_checkpoints/
3-
.vscode
4-
*.egg-info/
5-
*.pyc
6-
build/
7-
dist
8-
docs/_build
1+
# Manually added entries
2+
#
3+
jsdist
94
jupyter_server_proxy/labextension
10-
MANIFEST
115
node_modules
126
package-lock.json
7+
8+
9+
10+
# Copy pasted entries from:
11+
# https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
12+
#
13+
14+
# Byte-compiled / optimized / DLL files
15+
__pycache__/
16+
*.py[cod]
17+
*$py.class
18+
19+
# C extensions
20+
*.so
21+
22+
# Distribution / packaging
23+
.Python
24+
build/
25+
develop-eggs/
26+
dist/
27+
downloads/
28+
eggs/
29+
.eggs/
30+
lib/
31+
lib64/
32+
parts/
33+
sdist/
34+
var/
35+
wheels/
36+
share/python-wheels/
37+
*.egg-info/
38+
.installed.cfg
39+
*.egg
40+
PyInstaller
41+
# Usually these files are written by a python script from a template
42+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
43+
*.manifest
44+
*.spec
45+
46+
# Installer logs
47+
pip-log.txt
48+
pip-delete-this-directory.txt
49+
50+
# Unit test / coverage reports
51+
htmlcov/
52+
.tox/
53+
.nox/
54+
.coverage
55+
.coverage.*
56+
.cache
57+
nosetests.xml
58+
coverage.xml
59+
*.cover
60+
*.py,cover
61+
.hypothesis/
62+
.pytest_cache/
63+
cover/
64+
65+
# Translations
66+
*.mo
67+
*.pot
68+
69+
# Django stuff:
70+
*.log
71+
local_settings.py
72+
db.sqlite3
73+
db.sqlite3-journal
74+
75+
# Flask stuff:
76+
instance/
77+
.webassets-cache
78+
79+
# Scrapy stuff:
80+
.scrapy
81+
82+
# Sphinx documentation
83+
docs/_build/
84+
85+
# PyBuilder
86+
.pybuilder/
87+
target/
88+
89+
# Jupyter Notebook
90+
.ipynb_checkpoints
91+
92+
# IPython
93+
profile_default/
94+
ipython_config.py
95+
96+
# pyenv
97+
# For a library or package, you might want to ignore these files since the code is
98+
# intended to run in multiple environments; otherwise, check them in:
99+
# .python-version
100+
101+
# pipenv
102+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
103+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
104+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
105+
# install all needed dependencies.
106+
#Pipfile.lock
107+
108+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
109+
__pypackages__/
110+
111+
# Celery stuff
112+
celerybeat-schedule
113+
celerybeat.pid
114+
115+
# SageMath parsed files
116+
*.sage.py
117+
118+
# Environments
119+
.env
120+
.venv
121+
env/
122+
venv/
123+
ENV/
124+
env.bak/
125+
venv.bak/
126+
127+
# Spyder project settings
128+
.spyderproject
129+
.spyproject
130+
131+
# Rope project settings
132+
.ropeproject
133+
134+
# mkdocs documentation
135+
/site
136+
137+
# mypy
138+
.mypy_cache/
139+
.dmypy.json
140+
dmypy.json
141+
142+
# Pyre type checker
143+
.pyre/
144+
145+
# pytype static type analyzer
146+
.pytype/
147+
148+
# Cython debug symbols
149+
cython_debug/

‎.readthedocs.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Configuration on how ReadTheDocs (RTD) builds our documentation
2+
# ref: https://readthedocs.org/projects/jupyter-server-proxy/
3+
# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
4+
#
5+
version: 2
6+
7+
build:
8+
os: ubuntu-20.04
9+
tools:
10+
python: "3.9"
11+
12+
python:
13+
install:
14+
- requirements: docs/requirements.txt
15+
16+
sphinx:
17+
configuration: docs/conf.py
18+
19+
formats: []

‎contrib/theia/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Theia IDE
33
=========
44

5-
`Theia <https://www.theia-ide.org/>`_ is a configurable web based IDE
5+
`Theia <https://theia-ide.org/>`_ is a configurable web based IDE
66
built with components from `Visual Studio Code <https://code.visualstudio.com/>`_.
77

88
This package is a plugin for `jupyter-server-proxy <https://jupyter-server-proxy.readthedocs.io/>`_
@@ -12,12 +12,12 @@ in a JupyterHub / Binder environment.
1212
Installing Theia
1313
================
1414

15-
#. `Install the ``yarn`` package manager <https://yarnpkg.com/lang/en/docs/install/#alternatives-stable>`_
15+
#. `Install the ``yarn`` package manager <https://classic.yarnpkg.com/en/docs/install/>`_
1616
with one of the available methods.
1717

1818
#. Theia is highly configurable, so you need to decide which features you want
1919
in your theia install. Make a ``package.json`` with the list of extensions you want,
20-
following `the instructions here <https://www.theia-ide.org/doc/Composing_Applications.html>`_.
20+
following `the instructions here <https://theia-ide.org/docs/composing_applications/>`_.
2121

2222
Here is an example:
2323

‎docs/Makefile‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
5+
SPHINXOPTS ?=
6+
SPHINXBUILD ?= sphinx-build
77
SOURCEDIR = .
88
BUILDDIR = _build
99

@@ -16,4 +16,21 @@ help:
1616
# Catch-all target: route all unknown targets to Sphinx using the new
1717
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1818
%: Makefile
19-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
21+
# Manually added commands
22+
# ----------------------------------------------------------------------------
23+
24+
# For local development:
25+
# - builds and rebuilds html on changes to source
26+
# - starts a livereload enabled webserver and opens up a browser
27+
devenv:
28+
sphinx-autobuild -b html --open-browser "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)
29+
30+
# For local development and CI:
31+
# - verifies that links are valid
32+
linkcheck:
33+
$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)/linkcheck" $(SPHINXOPTS)
34+
@echo
35+
@echo "Link check complete; look for any errors in the above output " \
36+
"or in $(BUILDDIR)/linkcheck/output.txt."

‎docs/_static/images/logo/favicon.ico‎

4.45 KB
Binary file not shown.

0 commit comments

Comments
 (0)