diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index 6fbafab2..640bb9cd 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,7 +1,6 @@ -# Note that there is also a Pipfile for this project if you are updating this +# Note that there is also a Pipfile for this project if you are updating this # file do not forget to update the Pipfile accordingly sphinx>=1.4, !=1.5.4 recommonmark -alabaster -alabaster_jupyterhub sphinxcontrib-autoprogram +git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master diff --git a/docs/source/_static/images/logo.png b/docs/source/_static/images/logo.png new file mode 100644 index 00000000..9e03007d Binary files /dev/null and b/docs/source/_static/images/logo.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py index 2c2ea871..ee8aff28 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -109,7 +109,7 @@ pygments_style = "sphinx" todo_include_todos = False # repo2docker Logo -html_logo = "_static/images/repo2docker.svg" +html_logo = "_static/images/logo.png" html_favicon = "_static/images/favicon.ico" # -- Options for HTML output ---------------------------------------------- @@ -117,10 +117,7 @@ html_favicon = "_static/images/favicon.ico" # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -import alabaster_jupyterhub - -html_theme = "alabaster_jupyterhub" -html_theme_path = [alabaster_jupyterhub.get_html_theme_path()] +html_theme = "pandas_sphinx_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -132,9 +129,7 @@ html_theme_path = [alabaster_jupyterhub.get_html_theme_path()] # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] -html_sidebars = { - "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"] -} +html_sidebars = {} # -- Options for HTMLHelp output ------------------------------------------ diff --git a/docs/source/config_files.rst b/docs/source/config_files.rst index ad2a0985..26f269cb 100644 --- a/docs/source/config_files.rst +++ b/docs/source/config_files.rst @@ -17,12 +17,8 @@ GitHub contains a list of sample repositories for common configurations that ``repo2docker`` can build with various configuration files such as Python and R installation in a repository. -Below is a list of supported configuration files (roughly in the order of build priority): - -.. contents:: - :local: - :depth: 1 - +A list of supported configuration files (roughly in the order of build priority) +can be found on this page (and to the right). .. _environment.yml: diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst new file mode 100644 index 00000000..fbd26c20 --- /dev/null +++ b/docs/source/configuration/index.rst @@ -0,0 +1,13 @@ +=========================== +Configuring your repository +=========================== + +Information about configuring your repository to work with repo2docker, +and controlling elements of the built environment using configuration files. + +.. toctree:: + :maxdepth: 2 + :caption: Complete list of configuration files + + ../config_files + ../specification diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst new file mode 100644 index 00000000..2973791b --- /dev/null +++ b/docs/source/contributing/index.rst @@ -0,0 +1,17 @@ +============ +Contributing +============ + +The repo2docker community is welcoming of all kinds of help and +participation from others. Below are a few ways that you can get involved, +as well as resources for understanding the structure and design of the +repo2docker package. + +.. toctree:: + + contributing + roadmap + ../architecture + ../design + tasks + buildpack \ No newline at end of file diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst new file mode 100644 index 00000000..96e5f295 --- /dev/null +++ b/docs/source/getting-started/index.rst @@ -0,0 +1,13 @@ +=============== +Getting Started +=============== + +Instructions and information on how to get started with repo2docker +on your own machine. Select from the pages listed below to begin. + +.. toctree:: + :maxdepth: 2 + + ../install + ../usage + ../faq \ No newline at end of file diff --git a/docs/source/howto/index.rst b/docs/source/howto/index.rst new file mode 100644 index 00000000..c7ee34a3 --- /dev/null +++ b/docs/source/howto/index.rst @@ -0,0 +1,17 @@ +============= +How-to Guides +============= + +Short, actionable guides that cover specific topics with repo2docker. +Select from the pages listed below to get started. + +.. toctree:: + :maxdepth: 2 + :caption: How-To guides + + user_interface + languages + export_environment + lab_workspaces + jupyterhub_images + deploy diff --git a/docs/source/index.rst b/docs/source/index.rst index 17b11672..6a58c72e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,38 +25,15 @@ Please report `Bugs `_, :maxdepth: 2 :caption: Getting started with repo2docker - install - usage - faq - -.. toctree:: - :maxdepth: 2 - :caption: How-To guides - - howto/user_interface - howto/languages - howto/export_environment - howto/lab_workspaces - howto/jupyterhub_images - howto/deploy - -.. toctree:: - :maxdepth: 2 - :caption: Complete list of configuration files - - config_files - specification + getting-started/index + howto/index + configuration/index .. toctree:: :maxdepth: 2 :caption: Contribute to repo2docker - contributing/contributing - contributing/roadmap - architecture - design - contributing/tasks - contributing/buildpack + contributing/index .. toctree:: :maxdepth: 2