From a3ac1d8aa1875d253d34df1d92f852bd265f995a Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 6 Apr 2016 13:21:44 -0700 Subject: [PATCH] Add a configuration overview page to help with topic discoverability --- docs/source/config_overview.rst | 48 +++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 49 insertions(+) create mode 100644 docs/source/config_overview.rst diff --git a/docs/source/config_overview.rst b/docs/source/config_overview.rst new file mode 100644 index 000000000..951119f9d --- /dev/null +++ b/docs/source/config_overview.rst @@ -0,0 +1,48 @@ +.. _configuration-overview: + +Configuration Overview +====================== + +While Jupyter Notebook installs with default configuration settings, Jupyter +Notebook provides a rich array of options that may be configured to suit +your workflow. Let's explore four areas of configuration: + +- Jupyter's Common Configuration system +- Notebook server +- Notebook front-end client +- Notebook extensions + + +:ref:`Security in Jupyter notebooks ` is a topic worthy of +serious consideration. Since security policies will 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 recommend that you become familiar +with the practices. + +Jupyter's Common Configuration system +------------------------------------- +- Configuring a Jupyter application +- Configuring a language kernel +- Python configuration files +- Command line arguments +- traitlets low-level architecture for configuration + +Notebook server +--------------- + +- Configure the Notebook server +- Running a Notebook server +- Related: Configuring a language kernel + +Notebook front-end client +------------------------- +- How front-end configuration works + * Example: Changing the notebook's default indentation setting + * Example: Restoring the notebook's default indentation setting +- Persisting configuration settings + +Notebook extensions +------------------- +- Distributing Jupyter Extensions as Python Packages +- Extending the Notebook diff --git a/docs/source/index.rst b/docs/source/index.rst index 4d1498ade..376e02e19 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,6 +32,7 @@ The Jupyter notebook :maxdepth: 2 :caption: Configuration + config_overview config public_server security