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 theme to pandas sphinx #816

Merged
merged 4 commits into from
Nov 28, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -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
Binary file added docs/source/_static/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 3 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,15 @@ def setup(app):
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 ----------------------------------------------

# 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 All @@ -132,9 +129,7 @@ def setup(app):
# 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 ------------------------------------------

Expand Down
8 changes: 2 additions & 6 deletions docs/source/config_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
13 changes: 13 additions & 0 deletions docs/source/configuration/index.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/source/contributing/index.rst
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions docs/source/getting-started/index.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/source/howto/index.rst
Original file line number Diff line number Diff line change
@@ -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
31 changes: 4 additions & 27 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,38 +25,15 @@ Please report `Bugs <https://github.com/jupyter/repo2docker/issues>`_,
: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
Expand Down