Commit Graph

87 Commits

Author SHA1 Message Date
YuviPanda
3a9c631526 Provide consistent myst references to documentation pages
While doing https://github.com/jupyterhub/jupyterhub/pull/2726,
I realized we don't have a consistent way to format references
inside the docs. I now have them be formatted to match the name
of the file, but using `:` to separate them instead of `/` or `-`.
`/` makes it ambiguous when using with markdown link syntax, as
it could be a reference or a file. And using `-` is ambiguous, as
that can be the name of the file itself.

This PR does about half, I can do the other half later (unless
someone else does).
2024-06-10 19:11:51 -07:00
Min RK
4320f2aff5 document running build:watch with testing config
remove mentions of yarn - we don't use it
2024-04-15 11:20:51 +02:00
Simon Li
352826a1ec docs: fix unrelated rendering error 2024-03-21 20:08:59 +00:00
Simon Li
acf7d7daaa docs: use sphinx var for min node version 2024-03-21 20:08:56 +00:00
Simon Li
92d59cd12b docs: Consistently use minimum Python 3.8 2024-03-21 20:03:11 +00:00
krassowski
74455d6337 Bump required Python version in contributing setup 2024-03-19 12:52:59 +00:00
YuviPanda
a142876a4e docs: Remove non-actionable step from developer setup
I just went through these with @jmunroe, and found the
db step a little confusing - there is no action to really be
taken here, as pretty much everyone just uses sqlite for
development (and even production). So I've just removed that
step, as python almost always ships with sqlite built into it.
2023-12-17 13:05:19 -08:00
Samuel Gaist
09f65126d8 docs(dev): add address already in use troubleshooting hints
While it seems trivial, this can be a bit convoluted to debug on macOS
because some of the services might not be visible to the user logged in.

The solution is simple however knowing why it is needed is a good thing.
2023-08-08 09:59:44 +02:00
Min RK
9c83c15f67 Fix some public URL links within the docs
there shouldn't be any links to jupyterhub.readthedocs.io
2023-04-20 13:36:16 +02:00
alwasega
ecc2108710 Reverted to previous toctree 2023-02-17 08:25:03 +03:00
pre-commit-ci[bot]
bdfde0a256 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2023-02-16 10:12:40 +00:00
alwasega
ee2e830e03 Updates to the documentation Contribution section 2023-02-16 13:11:52 +03:00
Sheila Kahwai
f21743b751 add pytest-asyncio info under test organization 2023-02-13 10:48:37 +03:00
Sheila Kahwai
493d856872 add pytest-asycnio doc to toctree 2023-02-10 13:01:21 +03:00
Sheila Kahwai
2adb341769 add pytest-asyncio document 2023-02-10 12:09:08 +03:00
Sheila
057d32c166 Merge branch 'jupyterhub:main' into asyncio-doc 2023-02-10 12:01:42 +03:00
Sheila Kahwai
759c4c5ebc move information to tests.md 2023-02-08 17:24:15 +03:00
alwasega
c4d5762608 Moved Explanation/Background files 2023-02-06 11:31:37 +03:00
Erik Sundell
a9b6d7e51c docs: refresh Makefile/make.bat 2022-12-07 21:24:59 +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
Min RK
8b988dc0be fix link targets after rst2myst 2022-12-07 09:42:26 +01:00
Min RK
832e8c0348 run rst2myst 2022-12-07 08:58:00 +01:00
Min RK
8fe875430a Merge pull request #4209 from ArafatAbdussalam/patch-2
avoid contraction in setup.rst
2022-12-01 09:01:23 +01:00
Min RK
385a4556a4 Merge pull request #4119 from PoorvajaRayas/PoorvajaRayas
Formatting changes to tests.rst
2022-11-24 10:10:00 +01:00
PoorvajaRayas
869f2dd08d Reviewed documentation and fixed grammatical errors 2022-11-24 10:06:40 +01:00
Min RK
de5fb1e7ce Merge branch 'main' into copyediting 2022-11-24 09:40:21 +01:00
Erik Sundell
f877588e52 docs: fix rST syntax error for italics 2022-11-22 17:47:37 +01:00
Erik Sundell
1ac9c443b5 maint: add test to extras_require, remove dev-requirements.txt 2022-11-22 13:51:28 +01:00
Arafat Abdussalam
d2c6ae925f modified setup.rst
When I needed to set up Linux on my windows, i found out the easier to do so was through Windows Subsystem for Linux. Hence, I needed to add the guide to the development setup
2022-11-14 10:45:14 +01:00
Arafat Abdussalam
32cddfbdfe Update docs.rst 2022-11-14 10:30:56 +01:00
Min RK
36d596a4d3 Merge pull request #4169 from emmanuella194/main
typo in contributing doc
2022-10-26 09:42:05 +02:00
Emmanuella Orioma
488331e033 Update docs.rst
I corrected the spelling error in line 21
2022-10-25 23:26:16 +03:00
Chinwendu
cde1b65252 Update docs/source/contributing/community.md
Co-authored-by: Min RK <benjaminrk@gmail.com>
2022-10-25 16:11:52 +01:00
lumenCodes
7a22a2cf93 Addittion to the contributing .md 2022-10-24 17:36:38 +01:00
Min RK
2c4c5fc6fe Merge pull request #4159 from liliyao2022/patch-7
Update roadmap.md
2022-10-24 11:35:52 +02:00
Lili Yao
ad25ef8f87 Update roadmap.md
It seems that we don't need an "a" here, or should we change it to "an" instead?
2022-10-23 15:42:57 +11:00
Allan Wasega
9d93df6baf Fixed a minor error 2022-10-22 00:57:04 +03:00
pre-commit-ci[bot]
39eb1f055f [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-21 21:40:42 +00:00
Allan Wasega
74b0ebefe9 Fixed minor issues in community communication channels file 2022-10-22 00:34:23 +03:00
Georgiana
30e652f59e Merge pull request #4081 from Christiandike/Update/docs
Migrate community channels to markdown, update text
2022-10-19 11:59:43 +02:00
pre-commit-ci[bot]
d407c96ee8 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-19 09:47:27 +00:00
Christian Dike
84e1216dda Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:45:49 +01:00
Christian Dike
c8aae0ea1c Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:44:41 +01:00
Christian Dike
313623256f Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:44:15 +01:00
Georgiana
da7ac11605 Merge pull request #4069 from chicken-biryani/main
Update the testing docs
2022-10-19 11:29:36 +02:00
Shloka
15b8857728 Update docs/source/contributing/tests.rst
Co-authored-by: Min RK <benjaminrk@gmail.com>
2022-10-17 22:30:55 +05:30
Shloka
79ea4038e5 Update docs/source/contributing/tests.rst
Co-authored-by: Min RK <benjaminrk@gmail.com>
2022-10-17 22:30:47 +05:30
pre-commit-ci[bot]
838719e7ab [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-17 15:11:38 +01:00
Christian Dike
6ca5c1a276 Update documentation
Fix structure of documentation to aid readability and flow.
2022-10-17 15:09:40 +01:00
Min RK
93529d11bc Merge pull request #4065 from chicken-biryani/community-channels
Modification in community channels docs
2022-10-17 13:01:00 +02:00