Commit Graph

88 Commits

Author SHA1 Message Date
Min RK
6905c75cea skip linkcheck for linux.die.net
links work, but site seems to block linkcheck requests from CI with 403
2023-09-29 11:10:45 +02:00
Min RK
c3d4885521 Merge pull request #4428 from minrk/faq-share
update sharing faq for 2023
2023-05-10 17:08:32 +02:00
Min RK
cbacdecb1e update sharing faq for 2023 2023-04-20 13:52:01 +02:00
Min RK
203f4a5855 test PRs against base ref
rather than making assumptions about checkouts and origins
2023-04-19 15:56:09 +02:00
Erik Sundell
d5478b1f21 maint: let rediraffecheckdiff compare with origin/main, not main 2023-04-19 15:08:00 +02:00
Min RK
1e49b4379b set rediraffe auto redirect percentage to 80% 2023-04-19 13:37:17 +02:00
Min RK
a5d563217c check redirects in test-docs
check all for:

- this PR
- latest tag
- longer term (3.0)
2023-04-19 13:27:51 +02:00
Min RK
a5c59d6550 Re-enable links to REST API
- fix path to oauth spec
- enable attrs_inline for external link handling to internal targets
2023-03-08 07:51:03 +01:00
Min RK
ca760fc0df add singleuser explanation doc 2023-02-28 16:21:49 +01:00
Min RK
0b5a992605 update nav links for new theme 2023-02-20 15:08:47 +01:00
Min RK
3e9cd8acf8 use jupyterhub sphinx theme 2023-02-20 15:06:41 +01:00
alwasega
ce1264cd18 fixed typos in conf.py 2023-01-31 21:06:56 +03:00
pre-commit-ci[bot]
2755966adf [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2023-01-31 14:00:04 +00:00
alwasega
bea35a60df Added missed redirects manually and updated comments on conf.py 2023-01-31 17:01:38 +03:00
pre-commit-ci[bot]
da5183a6f8 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2023-01-31 08:01:26 +00:00
alwasega
dd0b49c8f4 Added rediraffe using auto redirect builder 2023-01-31 10:58:21 +03:00
Min RK
57a22719a5 docs: fix linkcheck in gallery
- jupyter.chameleoncloud SSL is failing (I can reproduce with conda curl, but not /usr/bin/curl, so seems to be a CA issue)
- remove dead arnesund tag link (keep single article link)
2023-01-13 10:49:21 +01:00
Min RK
593112807b resolve linkcheck failures
- several http->https
- a few page moves
- miniconda->miniforge
- remove rochester from gallery, which doesn't apepar to be publicly documented (may be accessible internally, but that's not for a public gallery)
2022-12-07 15:10:42 +01:00
Erik Sundell
71d5e604cb docs: use MyST fieldlist and substitution 2022-12-07 14:16:22 +01:00
Min RK
832e8c0348 run rst2myst 2022-12-07 08:58:00 +01:00
Erik Sundell
bfe0186ad2 docs: add rediraffe sphinx extension
This extension helps us restructure our documentation without creating
dead links. It requires us to explicitly declare what should be
redirected where though.

It seems better to have it in place ahead of time than to be something
we ask a contributor add just in time when its needed.
2022-11-22 17:47:37 +01:00
Erik Sundell
d23e095106 docs: add opengraph sphinx extension
This extension helps add metadata etc to the rendered HTML documentation
to help for example links on discourse.jupyter.org look good.
2022-11-22 17:47:37 +01:00
Erik Sundell
96d4486ae5 docs: refresh conf.py for readability 2022-11-22 17:47:37 +01:00
Erik Sundell
0575022186 docs: install jupyterhub package and remove path setup steps
When we install the jupyterhub package, we don't have to put it on the
path explicitly.
2022-11-22 13:51:28 +01:00
Min RK
d5d9cb204c Merge pull request #4219 from consideRatio/pr/stricter-flake8
pre-commit: add autoflake and make flake8 checks stricter
2022-11-21 15:10:14 +01:00
Erik Sundell
1c9499e91e docs: remove epub documentation build 2022-11-17 13:09:06 +01:00
Erik Sundell
26e5efeec4 docs: cleanup unused config for htmlhelp, latex, manual 2022-11-17 13:08:17 +01:00
Erik Sundell
7a9491c323 flake8: check F408 about unused imports, manual fixes only 2022-11-16 15:51:26 +01:00
Min RK
8aac18c96d More documentation for 3.0 role/scope changes
a few more outdated `versionchanged` notes
2022-08-02 14:39:03 +02:00
Min RK
7a9778249f run pre-commit with isort 2022-03-31 12:33:26 +02:00
Min RK
8f18303e50 fix some links revealed by myst
mostly pre-myst markdown links
2022-03-04 10:41:20 +01:00
Min RK
08a913707f define html_context needed for edit_page_button 2022-01-20 18:56:41 +01:00
pre-commit-ci[bot]
1b3e94db6c [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-01-04 22:23:45 +00:00
Chris Holdgraf
614d9d89d0 DOCS: Update theme configuration 2022-01-04 14:22:45 -08:00
Min RK
7d44a0ffc8 add tornado to intersphinx 2021-11-30 10:45:38 +01:00
Min RK
468aa5e93c render openapi spec client-side
- move spec to _static/rest-api.yml, since the original yaml must be served
- copy javascript rendering code from FastAPI (uses swagger-ui)
- remove link to pet store, since there isn't a big enough difference to duplicate it
- remove bootprint rendering with node
2021-10-29 13:13:41 +02:00
Min RK
14997152b9 admonition about installing the beta 2021-09-17 10:54:43 +02:00
Erik Sundell
d6c48b15fe pyupgrade: run pyupgrade --py36-plus and black on all but tests 2021-08-26 16:23:38 +02:00
Min RK
b1b6a9e76c Add detailed doc for starting/stopping/waiting for servers via api
and complete implementation in examples/server-api
2021-08-04 12:49:12 +02:00
IvanaH8
800f3cf79f Add trigger to conf.py to call generate-scope-table 2021-05-21 17:03:24 +02:00
IvanaH8
c03ca796ab removed recommonmark from docs/source/conf.py 2021-02-19 14:07:25 +01:00
IvanaH8
7d1b6a2021 split the docs in docs/source/rbac folder 2021-02-15 16:19:13 +01:00
IvanaH8
be34146d29 back-up with commenting out only 2021-02-12 09:55:21 +01:00
Erik Sundell
4cbc0bad34 Merge branch 'master' into remove-unused-imports 2020-10-01 12:07:37 +02:00
Erik Sundell
e15b6ad52e Makefile: let make html depend on generated metrics.rst 2020-10-01 10:13:31 +02:00
Rajat Goyal
8ee60ce0c7 Add metrics documentation generation step in CircleCI & RTD configs
Also rename generated metrics documentation directory `_gen` from `gen`
2020-09-30 22:57:46 +05:30
Min RK
21eaf0dd9f Merge pull request #3077 from kinow/add-config-reference
Add Configuration Reference section to docs
2020-09-08 16:40:10 +02:00
Erik Sundell
4bc6d869f3 docs: unsqueeze logo, remove unused CSS and templates 2020-07-05 03:12:18 +02:00
Bruno P. Kinoshita
522ef3daea Add Configuration Reference 2020-06-08 23:49:31 +12:00
Richard Darst
e882e7954c docs: use recommonmark as an extension
- source_parsers deprecated in sphinx 3.0
- Since sphinx 1.4, it can (should) be used as a direct extension:
  https://github.com/readthedocs/recommonmark/pull/43
2020-04-17 11:11:24 +03:00