Commit Graph

423 Commits

Author SHA1 Message Date
Min RK
acdd9bb674 Merge pull request #2203 from minrk/entrypoints
allow spawners and authenticators to register via entry points
2018-10-01 17:22:11 +02:00
Chris Holdgraf
372af86250 rst code syntax in docs 2018-09-29 09:09:31 -07:00
Chris Holdgraf
c48988afcb pip command update 2018-09-28 12:00:28 -07:00
Min RK
c02ab23b3d allow spawners and authenticators to register via entrypoints
jupyterhub.authenticators for authenticators, jupyterhub.spawners for spawners

This has the effect that authenticators and spawners can be selected by name instead of full import string (e.g. 'github' or 'dummy' or 'kubernetes')
and, perhaps more importantly, the autogenerated configuration file will include a section for each installed and registered class.
2018-09-28 10:08:10 +02:00
Kyla Harper
a78655c5a7 Add DummyAuthenticator documentation 2018-09-27 11:42:06 -05:00
Min RK
fa79e233b7 Merge pull request #2196 from choldgraf/copybutton
add a copy button to code cells
2018-09-27 14:13:56 +02:00
yuvipanda
6ca5b3aa70 Fixup upgrade toctree in index.rst 2018-09-27 00:16:24 -07:00
yuvipanda
e6a5dd1273 Fixes per @betatim & @choldgraf 2018-09-27 00:13:07 -07:00
yuvipanda
358b830747 Expand & consolidate upgrade documentation
- Expands the previous documentation on upgrading JupyterHub
  to include more information.
- Remove specific documentation on 0.7 -> 0.8 upgrade, since
  this seems to be a straight copy of the markdown version of
  upgrading docs. The important thing about the 0.7 -> 0.8 upgrade
  (requiring versions of JupyterHub to match) is now in the
  main document.
- Move from markdown to rst
2018-09-26 23:53:51 -07:00
yuvipanda
a91e94dd16 Re-order 'upgrading' section in main documentation page
Info on upgrading is important & relevant. This consolidates
the index to be a bit better. Next step is to consolidate the
documentation into one page.

Removes the 'tutorials' index page as well, since that only
had a reference to z2jh (which is now referenced from the
'distribution' section). The distribution section has
better visibility too
2018-09-26 23:53:19 -07:00
Chris Holdgraf
3dc0a8388b copy button 2018-09-26 18:34:51 -04:00
yuvipanda
7c273296c2 Use python3 -m pip explicitly in docs
- Add a documentation convention listing this too.

Fixes #2191
2018-09-26 12:14:43 -07:00
yuvipanda
b9331dbd57 Reformat index.rst to get linkable sections
Currently, the sections in index.rst are using ** for bold,
rather than true section headers. This prevents them from being
linkable. Since we'd like to link to the 'contributing' section
from CONTRIBUTING.md, we change this by moving everything to
section headers. We also move to the toctree directive, since
it keeps the bullets aligned properly (they were hanging if
we used simple * markers)

This also replaces CONTRIBUTING.md content with a link to
the docs.
2018-09-25 18:35:38 -07:00
yuvipanda
c928d10316 Expand contributor documentation
- Move from CONTRIBUTING.md to a subdirectory in docs, so
  we can expand and add more documentation.
- Move from markdown to reStructuredTest
- Add a direct blurb in the JupyterHub docs index page on
  how contribution.
- More prominent link to the Code of Conduct
- Add section on getting in touch with the JupyterHub community
2018-09-25 18:19:09 -07:00
Min RK
33c6e68b5e update changelog for 0.9.4 2018-09-24 14:01:23 +02:00
Min RK
c87fcd9b71 Merge pull request #2155 from minrk/cleanup-client-fix
fix oauth client cleanup
2018-09-21 10:10:34 +02:00
yuvipanda
07b590e2c3 Link additional authenticators to wiki
The current list in the docs is out of date. The list
in the wiki is more up-to-date, and easier for folks
to change over time. In the long run, we should decide
where lists like this belong.
2018-09-20 22:49:00 -07:00
Min RK
4cd4fd1dff changelog for 0.9.4 2018-09-19 12:48:21 +02:00
Carol Willing
7ff49705bc fix typo 2018-09-12 08:41:05 -07:00
Carol Willing
6dc43dd70b add link to community guide reference 2018-09-12 08:39:07 -07:00
Min RK
0239ff8646 changelog for 0.9.3
Mainly small fixes, but the token page could be completely broken

This release will include the spawner.handler addition,
but not the oauthlib change currently in master
2018-09-11 11:06:31 +02:00
Carol Willing
30d9e09390 fix link 2018-09-05 11:27:19 -07:00
Matthias Bussonnier
077d8dec9a Fix some typos using codespell.
And checking each manually. It's funny because one of the words in the
sphinx custom dictionary was wrong :-)
2018-08-29 21:24:28 -07:00
Min RK
85aac0fa2d prepare to release 0.9.2 2018-08-10 13:56:58 +02:00
Kenan Erdogan
71cb628563 fix links in services doc 2018-08-06 11:11:14 +02:00
Matthias Bussonnier
a1c2a50810 Switch protocols to https in docs links
Chrome will start to show insecure website for http next week
2018-07-22 18:58:22 -07:00
Min RK
22863f765f 0.9.1 2018-07-04 11:55:42 +02:00
Min RK
55f58b3ba7 review, note proxy prefix fix 2018-07-03 15:12:30 +02:00
Min RK
7dfdc23b4e Prepare changelog for 0.9.1 2018-07-03 11:44:37 +02:00
Alex Marandon
678afd3783 Fix a couple of typos 2018-07-03 11:16:55 +02:00
Min RK
30f19cfc8c mention get_env and get_args in spawner reference
these are important and usually required (especially get_env) for custom Spawner implementations
2018-06-29 14:46:08 +02:00
Carol Willing
a507fa1c8a add templates and user env docs to home page index 2018-06-16 10:21:33 -07:00
Min RK
6f15113e2a link and date for 0.9.0 2018-06-15 15:36:48 +02:00
Carol Willing
21496890f6 Remove stray bullet that I missed in review 2018-06-13 11:10:41 -07:00
Carol Willing
70dcd50e44 Merge pull request #1976 from minrk/changelog-more
last few things in changelog
2018-06-13 11:09:30 -07:00
Min RK
57075aba52 Add last few entries in changelog for 0.9 2018-06-13 15:15:18 +02:00
Min RK
edd8e21f71 Merge pull request #1969 from willingc/edit-userenv
Edit and reflow user environment reference
2018-06-13 09:49:23 +02:00
Carol Willing
84c82fe382 update the contributor list for 0.9 2018-06-12 14:51:51 -07:00
Carol Willing
5e45e76f5b update contributors for 0.9 2018-06-12 14:36:00 -07:00
Jason Williams
cb5ef0c302 Update troubleshooting.md 2018-06-12 17:01:37 -04:00
Jason Williams
34fab033fe Jupyterhub on Docker add workaround for unable to connect to localhost
Added a command that worked for me to fix the situation that localhost:8000 is unable to reach the hub even though the published command for Docker exposes the correct port.
2018-06-12 16:59:17 -04:00
Carol Willing
37f4c4429e edit and reflow user environment reference 2018-06-12 08:47:22 -07:00
Carol Willing
293410ec94 Merge pull request #1967 from minrk/config-docs
docs: configuring user environments
2018-06-12 07:55:53 -07:00
Min RK
ed6ee27dcd docs: configuring user environments
covers system-wide installation, kernelspec registration, and the differences between containers and host systems
2018-06-12 14:34:26 +02:00
Min RK
aa9676ec5e Merge pull request #1913 from rkdarst/announcement_text
Add customizable announcement text on home,login,logout,spawn
2018-06-12 14:14:21 +02:00
Min RK
5e93c7de4c announcement doc language
per willingc review
2018-06-12 13:48:42 +02:00
Carol Willing
1b7965092e remove backticks and long for rst format 2018-06-08 14:21:31 -07:00
Carol Willing
ef60be5a99 put backticks outside of link 2018-06-08 14:19:43 -07:00
Carol Willing
f78d652cd6 fix missing brackets 2018-06-08 14:18:14 -07:00
Carol Willing
3650575797 add a small section for pre/post spawn hooks 2018-06-08 14:13:45 -07:00