diff --git a/docs/source/conf.py b/docs/source/conf.py index 797bd36f61..d0f5478647 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -140,7 +140,7 @@ # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'default' -highlight_language = 'python3' +#highlight_language = 'python3' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] diff --git a/docs/source/config_overview.rst b/docs/source/config_overview.rst index ddcadeb8b4..65da08b7d0 100644 --- a/docs/source/config_overview.rst +++ b/docs/source/config_overview.rst @@ -58,7 +58,7 @@ Server extensions - `Distributing Jupyter Extensions as Python Packages `_ - `Extending the Server `_ -:ref:`Security in Jupyter: ` Since security +Since security policies vary from organization to organization, we encourage you to consult with your security team on settings that would be best for your use cases. Our documentation offers some responsible security practices, and we diff --git a/docs/source/frontends.rst b/docs/source/frontends.rst index 5fcd60cc67..42e1703e8b 100644 --- a/docs/source/frontends.rst +++ b/docs/source/frontends.rst @@ -6,6 +6,8 @@ Jupyter Server does not come with a frontend out-of-the-box; instead, a frontend .. note:: This documentation is written for experienced developers. +.. _frontend: + Writing a frontend application ------------------------------ @@ -61,15 +63,21 @@ To create a new Jupyter frontend application, subclass the ``ExtensionApp`` like # Change the jinja templating environment self.settings.update({'myfrontend_jinja2_env': ...}) -The ``ExtensionApp`` uses the following methods and properties to connect your frontend to the Jupyter server. Overwrite these methods to add your custom settings, handlers and templates: +The ``ExtensionApp`` uses the following methods and properties to connect your frontend to the Jupyter server. Overwrite these pieces to add your custom settings, handlers and templates: + +Methods * ``initialize_setting()``: adds custom settings to the Tornado Web Application. * ``initialize_handlers()``: appends handlers to the Tornado Web Application. * ``initialize_templates()``: initialize the templating engine (e.g. jinja2) for your frontend. + +Properties + * ``name``: the name of the extension * ``default_url``: the url that your extension will serve its homepage. * ``load_other_extensions``: should your extension expose other server extensions when launched directly? + Writing frontend handlers ------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 61ae97d5ea..69549c0fbf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,7 @@ Jupyter Server (Developer Preview) ================================== -Jupyter Server is a fork of the `Jupyter Notebook`_'s Tornado_ Server. It provides all the core services, APIs and `REST endpoints`_ from the classic Notebook Server without the Jupyter Notebook (Javascript) frontend. In fact, the Jupyter Server provides no frontend out-of-the-box; rather, it exposes hooks for Jupyter frontend creators to register their frontends with the Server. +Jupyter Server is a fork of the `Jupyter Notebook`_'s Tornado_ Server. It provides all the core services, APIs and `REST endpoints`_ from the classic Notebook Server without the Jupyter Notebook (Javascript) frontend. In fact, the Jupyter Server provides no frontend out-of-the-box; rather, it exposes `hooks `_ for Jupyter frontend creators to register their frontends with the Server. Before the Jupyter Server project, the `Jupyter Notebook`_ was the only first-class frontend to the Tornado Server. As a consequence, other Jupyter frontends had to include Jupyter Notebook (and all of its Javascript code) as a dependency. The Jupyter Server project views all frontends—including the `Jupyter Notebook`_—as equal and separate . @@ -24,9 +24,7 @@ To install the latest release of ``jupyter_server``, use *pip*: :maxdepth: 1 :caption: Table of Contents - server_config frontends - changelog .. toctree:: diff --git a/docs/source/security.rst b/docs/source/security.rst index 9720cbec16..e5727421b9 100644 --- a/docs/source/security.rst +++ b/docs/source/security.rst @@ -77,5 +77,3 @@ but this is **NOT RECOMMENDED**, unless authentication or access restrictions ar c.ServerApp.token = '' c.ServerApp.password = '' - -.. _server_security: