Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating to new theme #176

Merged
merged 2 commits into from Nov 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file modified doc/_static/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 1 addition & 4 deletions doc/conf.py
Expand Up @@ -87,10 +87,7 @@ def setup(app):
# 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
Expand Down
5 changes: 2 additions & 3 deletions doc/doc-requirements.txt
Expand Up @@ -3,8 +3,7 @@ sphinx_copybutton
traitlets
jupyterhub
sphinx>=1.3.6,!=1.5.4
alabaster
alabaster_jupyterhub
memory_profiler
pytest
PyGitHub
PyGitHub
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
16 changes: 16 additions & 0 deletions doc/howto/index.rst
@@ -0,0 +1,16 @@
=============
How to guides
=============

How-To guides are shorter, actionable patterns that
accomplish something specific.

.. toctree::
:caption: How to...
:maxdepth: 1

languages
user_interface
badges
repo_data
lab_workspaces
16 changes: 16 additions & 0 deletions doc/index-community.rst
@@ -0,0 +1,16 @@
=========
Community
=========



.. toctree::
:maxdepth: 2
:caption: Binder community

user-guidelines
faq
status
about
reliability
more-info
14 changes: 14 additions & 0 deletions doc/index-getting-started.rst
@@ -0,0 +1,14 @@
.. _getting-started:

===========
Get Started
===========

Information to help you get started with Binder.

.. toctree::
:caption: Getting started with Binder
:maxdepth: 2

introduction
using
13 changes: 13 additions & 0 deletions doc/index-repo-reference.rst
@@ -0,0 +1,13 @@
===========================
Example Binder repositories
===========================

Reference and example repositories that can be used as guidance and inspiration for
creating your own Binder repositories.

.. toctree::
:maxdepth: 2
:caption: Sample repositories and configuration

sample_repos
examples
54 changes: 9 additions & 45 deletions doc/index.rst
Expand Up @@ -26,17 +26,11 @@ If you'd like documentation on how to create and administer your own BinderHub d
see the `BinderHub documentation <http://binderhub.readthedocs.io>`_, which
guides you through deploying your own BinderHub.

Getting Started with Binder
===========================

If you're just getting started with Binder, see the pages below...

.. toctree::
:caption: Getting started with Binder
:maxdepth: 2

introduction
using
index-getting-started


How-To guides and Tutorials
===========================
Expand All @@ -46,28 +40,11 @@ your Binder repository. How-To guides are shorter, actionable patterns that
accomplish something specific. Tutorials are more high-level and thorough,
and often cover more conceptual topics.

.. note::

Binder is a research pilot, whose main goal is to understand usage patterns
and workloads for future evolution and development. It is not a service that
can be relied on for critical operations.

.. toctree::
:caption: How to...
:maxdepth: 1

howto/languages
howto/user_interface
howto/badges
howto/repo_data
howto/lab_workspaces

.. toctree::
:maxdepth: 2
:caption: Tutorials and in-depth guides

tutorials/reproducibility
tutorials/dockerfile

howto/index
tutorials/index


Sample repositories and configuration
Expand All @@ -78,16 +55,8 @@ you can do with Binder configuration files.

.. toctree::
:maxdepth: 2
:caption: Sample repositories and configuration

sample_repos
config_files

Finally, here is a list of interesting Binder repositories from around the web:

.. toctree::

examples

index-repo-reference

See the `Binder Examples <https://github.com/binder-examples>`_ GitHub
organization for more Binder repositories demonstrating its functionality.
Expand All @@ -101,15 +70,10 @@ guidelines for users and developers, and information about the ``mybinder.org``
service.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Binder community

user-guidelines
faq
status
about
reliability
more-info
index-community

.. _citing:

Expand Down
14 changes: 14 additions & 0 deletions doc/tutorials/index.rst
@@ -0,0 +1,14 @@
=========
Tutorials
=========

Tutorials cover certain topics in more depth. They are useful in understanding
concepts behind reproducible research and the technology that facililitates it.

.. toctree::
:maxdepth: 2
:caption: Tutorials and in-depth guides

reproducibility
dockerfile
../config_files