-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
212a0ac
commit 5c37e9a
Showing
24 changed files
with
1,236 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# mkdocs output directory | ||
site | ||
# copy of primary jupyter.md | ||
docs/jupyter.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Using dated tags from https://hub.docker.com/_/ubuntu/ | ||
FROM ubuntu:bionic-20201119 | ||
MAINTAINER RStudio Connect <[email protected]> | ||
|
||
# Configure apt-get to use the mirror in us-east-1 instead of the Docker default of archive.ubuntu.com | ||
RUN sed -i "s/archive.ubuntu.com/us-east-1.ec2.archive.ubuntu.com/g" /etc/apt/sources.list | ||
|
||
# git is used to examine the repository and compute product version. | ||
RUN export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get update && \ | ||
apt-get install -y \ | ||
git \ | ||
python3-pip && \ | ||
rm -rf /var/lib/apt/lists/* | ||
|
||
# Needed with Python3 mkdocs. | ||
# https://click.palletsprojects.com/en/7.x/python3/ | ||
ENV LC_ALL C.UTF-8 | ||
ENV LANG C.UTF-8 | ||
|
||
COPY requirements.txt requirements.txt | ||
RUN pip3 install -r requirements.txt && \ | ||
rm -f requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# RStudio Connect Jupyter User Guide | ||
|
||
This directory contains the RStudio Connect: Jupyter User Guide. We use | ||
[mkdocs-1.0.4](https://www.mkdocs.org) to build this guide. | ||
|
||
The Jupyter User Guide is geared towards the people who will publish Jupyter Notebooks to RStudio Connect. | ||
|
||
## Docker | ||
|
||
The `rsconnect-jupyter-docs` Docker image is used to produce our | ||
documentation. We use a number of plugins and extensions; use the Docker image | ||
rather than a local `mkdocs` installation. | ||
|
||
Create the image: | ||
```bash | ||
just image | ||
``` | ||
|
||
Build documentation: | ||
|
||
```bash | ||
just build | ||
``` | ||
|
||
Launch an auto-reloading documentation server at http://localhost:8001 with | ||
the command: | ||
|
||
```bash | ||
just watch | ||
``` |
Oops, something went wrong.