Commit Graph

45 Commits

Author SHA1 Message Date
Min RK
5c6825f298 myst 0.19 changed intersphinx link syntax 2023-03-01 11:02:33 +01:00
Min RK
3e9cd8acf8 use jupyterhub sphinx theme 2023-02-20 15:06:41 +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
Erik Sundell
90811196d7 docs: remove unused alabaster_jupyterhub requirement 2022-11-17 13:00:22 +01:00
Erik Sundell
4f7f07d3b7 Fix missing docs requirements 2022-01-10 11:18:22 +01:00
Min RK
0985d6fdf2 use stable autodoc-traits 2021-10-29 11:32:02 +02:00
Min RK
5789806cf7 Sync rbac with main 2021-06-15 11:06:11 +02:00
Min RK
77e4e8aab7 bump autodoc-traits
for sphinx compatibility fix
2021-06-15 08:07:40 +02:00
IvanaH8
f5bbe78dbd Resolve merge conflicts with rbac 2021-04-08 11:32:41 +02:00
IvanaH8
45a0945a6b updated requirements.txt 2021-02-17 15:46:10 +01:00
IvanaH8
7d1b6a2021 split the docs in docs/source/rbac folder 2021-02-15 16:19:13 +01:00
Erik Sundell
0155e6dc34 Run pre-commit requirements-txt-fixer 2021-02-12 19:24:22 +01:00
IvanaH8
be34146d29 back-up with commenting out only 2021-02-12 09:55:21 +01:00
Rajat Goyal
5b8a7fd191 Remove unused dependency 2020-09-30 23:25:22 +05:30
Rajat Goyal
e553bcb7e2 Unpin dependencies from their patch versions 2020-09-30 22:08:50 +05:30
Rajat Goyal
dcd520179c Made changes in monitoring docs as per the feedback on PR review 2020-09-30 22:08:50 +05:30
rajat404
7ed3e0506b Extract doc generation logic in separate method 2020-09-30 22:08:50 +05:30
rajat404
7045e1116c Inspect metrics and generate metric list in docs; Add monitoring section in Docs 2020-09-30 22:08:50 +05:30
Richard Darst
9d6e8e6b6f Temporary patch autodoc-traits to fix build error [temporary]
- This commit should be removed later after autodoc-traits is fixed upstream
2020-04-17 11:43:49 +03:00
GeorgianaElena
854d0cbb86 Add package requirements to docs build 2020-04-02 10:32:11 +03:00
GeorgianaElena
87212a7414 Remove comment referencing conda environment 2020-04-02 08:55:04 +03:00
GeorgianaElena
78c14c05f3 Switch to pip on rtd 2020-04-01 14:23:35 +03:00
Chris Holdgraf
3425eca4ff updating docs theme 2020-03-23 08:10:49 -07:00
Simon Li
996483de94 Pin sphinx theme (https://github.com/jupyterhub/binderhub/pull/1070)
Closes https://github.com/jupyterhub/jupyterhub/issues/2955
2020-02-27 17:35:52 +00:00
Min RK
d2a1b8e349 update docs environments
- python 3.7
- node 12
- sync recommonmark 0.6
2020-02-20 15:32:55 +01:00
Chris Holdgraf
e44ee6ed8a reordering requirements 2019-11-21 08:05:13 -08:00
Chris Holdgraf
c8e4d68978 updating to pandas docs theme 2019-11-21 08:04:20 -08:00
Min RK
ca00c0eab0 Merge pull request #2698 from Zsailer/eventlog-tests
Instrument JupyterHub to record events with jupyter_telemetry [Part II]
2019-09-24 11:08:45 +02:00
Min RK
ac32ae496e run pre-commit hook 2019-09-19 15:51:02 +02:00
Carol Willing
6d696758e4 use autodoc-traits extension for docbuild 2019-09-06 17:41:34 +02:00
Zsailer
c34bcabcb9 add docs for event-logging 2019-08-22 11:05:10 -07:00
Min RK
45dcb3bd17 recommonmark 0.5
update several links (html targets don't work anymore)

had to add rest-api redirect so link would resolve,
since there isn't a ref for files in _static
2019-03-25 14:08:37 +01:00
Min RK
5e60582ef3 run autoformat
apologies to anyone finding this commit via git blame or log

run the autoformatting by

    pre-commit run --all-files
2019-02-19 17:00:10 +01:00
Min RK
10191f43fe add alabaster_jupyterhub to docs/requirements.txt 2019-02-06 13:15:11 +01:00
Min RK
ec6123d39d include sphinx-copybutton in docs/requirements.txt 2018-09-27 12:58:51 +02:00
Tim Head
7b6dd9f5cf Update dependencies used by ReadTheDocs 2018-07-26 12:53:19 +02:00
Carol Willing
90e6b63e59 bump tornado and sphinx versions 2018-05-03 04:37:33 +02:00
Carol Willing
bd78217cf3 remove jupyter alabaster theme from requirements 2018-05-03 04:34:56 +02:00
Seak Pek Chhan
ebaf5d31b7 add jupyter-alabaster-theme to doc requirements.txt 2017-11-18 04:04:28 -05:00
charnpreetsingh
41c136392f Sphinx min version is 1.4 2017-05-03 16:00:31 -07:00
Carol Willing
2820ba319f Update sphinx version for md on rtd 2016-03-11 07:55:49 -08:00
Min RK
51a04258d1 build on readthedocs 2016-01-20 15:35:49 +01:00