Merge pull request #1160 from choldgraf/docs-update

Remove federation related docs to split using and operating a bhub docs

Author: consideRatio

.circleci/config.yml

@@ -1,7 +1,3 @@
-img.logo {
-  width:100%
-}
-
 .right-next {
     float: right;
     max-width: 45%;

doc/_static/custom.css

@@ -48,7 +48,8 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'autodoc_traits',
-    'sphinx_copybutton'
+    'sphinx_copybutton',
+    'myst_parser',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -58,12 +59,6 @@
 # You can specify multiple suffix as a list of string:
 source_suffix = ['.rst', '.md']
 
-# Support markdown via recommonmark:
-from recommonmark.parser import CommonMarkParser
-source_parsers = {
-    '.md': CommonMarkParser,
-}
-
 # The master toctree document.
 master_doc = 'index'
 
@@ -114,7 +109,11 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {}
+html_theme_options = {
+  "use_edit_page_button": True,
+  "github_url": "https://github.com/jupyterhub/binderhub",
+  "twitter_url": "https://twitter.com/mybinderteam",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -222,8 +221,3 @@ def create_internal_redirects(app, docname):
 
 def setup(app):
     app.connect("build-finished", create_internal_redirects)
-
-# -- Run Federation script ----------------------------------------------
-from subprocess import run
-cmd = ["python", op.join('script', 'gen_federation.py')]
-run(cmd)

doc/community/index.rst

@@ -0,0 +1,2 @@
+```{include} ../CONTRIBUTING.md
+```

doc/conf.py

@@ -1,14 +1,15 @@
-Customization
-=============
+Customize and Maintain
+======================
 
-Information on how to customize your BinderHub as well as explore what others
-in the community have done.
+These pages cover common use-cases and needs when deploying your own BinderHub.
+This includes configuring and customizing your BinderHub deployment, as well as
+best-practices in debugging issues.
 
 .. toctree::
    :maxdepth: 2
    :caption: Customization and deployment
 
-   ../debug
    ../customizing
+   ../debug
    ../authentication
    ../https

doc/contribute.md

@@ -1,5 +1,5 @@
-Administrators and developers
-=============================
+Technical Reference
+===================
 
 A more detailed overview of the BinderHub design, architecture, and functionality.
 

doc/customization/index.rst

@@ -1,11 +1,11 @@
 # documentation specific extra packages
-sphinx>=1.7
-recommonmark==0.4.0
+myst-parser
 sphinx-copybutton
 traitlets
 pandas
 ruamel.yaml
 pydata_sphinx_theme
+sphinx>=1.7
 # install BinderHub dependencies. We manually list them here because some
 # dependencies (like pycurl) can't be installed on ReadTheDocs and aren't
 # needed to build the docs.