From 4c0131131c0dc30d603b584a16a142255437ef7d Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Tue, 6 Jul 2021 15:47:41 -0400 Subject: [PATCH 01/33] First pass rework --- docs/docs/index.md | 185 ++++++++++++++++--------------- docs/docs/snippets/python_pkg.md | 25 +++++ docs/mkdocs.yml | 1 + 3 files changed, 121 insertions(+), 90 deletions(-) create mode 100644 docs/docs/snippets/python_pkg.md diff --git a/docs/docs/index.md b/docs/docs/index.md index 295f2bee..bcc13913 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -15,42 +15,107 @@ ## Installation -- If you are installing `rsconnect-jupyter` for use in Jupyterhub, please see -the [Installation in Jupyterhub](#installation-in-jupyterhub) section below. +The installation method depends on your Python environment that you are installing the `rsconnect-jupyter` package into. + +This documentation covers three method: + +- [Installing in JupyterHub](#installing-in-jupyterhub) +- [Installing to Jupyter running on RStudio Workbench](#installing-to-jupyter-running-on-rstudio-workbench) +- [Installing Jupyter within a virtual environment](#installing-jupyter-within-a-virtual-environment) + +Please skip to the installation section below that is best for your environment. + + +### Installing in JupyterHub + +In JupyterHub, follow these directions to install the +`rsconnect-jupyter` package into the Python environment where the Jupyter +notebook server and kernel are installed: + + +--8<-- "snippets/python_pkg.md" + +Typically those will be the same +environment. If you've configured separate kernel environments, install the +`rsconnect-jupyter` package in the notebook server environment as well as each +kernel environment. + +The exact install location depends on your Jupyterhub configuration. + +#### JupyterHub Example Configuration + +This section presents a simple working example of a Jupyterhub configuration +with `rsconnect-jupyter` installed. + +??? example "Docker Example" + This example uses Docker, but you can install the `rsconnect-jupyter` package in + any Jupyterhub installation. Docker is not required. + + Example Dockerfile: + +

Dockerfile

+ ```dockerfile + FROM jupyterhub/jupyterhub:0.9.4 + + # Install Jupyter notebook into the existing base conda environment + RUN conda install notebook + + # Download and install rsconnect-jupyter in the same environment + # Update this to specify the desired version of the rsconnect-jupyter package, + # or pass `--build-arg VERSION=...` to docker build. + ARG VERSION=RSCONNECT_VERSION + ARG REPOSITORY=https://s3.amazonaws.com/rstudio-rsconnect-jupyter + + RUN wget ${REPOSITORY}/rsconnect_jupyter-${VERSION}-py2.py3-none-any.whl + RUN pip install rsconnect_jupyter-${VERSION}-py2.py3-none-any.whl && \ + jupyter-nbextension install --sys-prefix --py rsconnect_jupyter && \ + jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter && \ + jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter + + # create test users + RUN useradd -m -s /bin/bash user1 && \ + useradd -m -s /bin/bash user2 && \ + useradd -m -s /bin/bash user3 && \ + bash -c 'echo -en "password\npassword" | passwd user1' && \ + bash -c 'echo -en "password\npassword" | passwd user2' && \ + bash -c 'echo -en "password\npassword" | passwd user3' + + CMD ["jupyterhub"] + ``` + + Run these commands to build and start the container: + +

Terminal

+ ```bash + docker build -t jupyterhub:rsconnect-jupyter . + docker run --rm -p 8000:8000 --name jupyterhub jupyterhub:rsconnect-jupyter + ``` + + Connect to Jupyterhub on http://localhost:8000 and log in as one of the test + users. From there, you can create a notebook and publish it to RStudio Connect. + Note that the current Jupyterhub docker image uses Python 3.6.5, so you will + need a compatible Python version installed on your RStudio Connect server. + +--- + +### Installing to Jupyter running on RStudio Workbench + - If you are installing `rsconnect-jupyter` to Jupyter running on RStudio Server Pro, see the [RStudio Server Pro documentation on Jupyter Notebooks](https://docs.rstudio.com/rsp/integration/jupyter-standalone/#4-install-jupyter-notebooks-jupyterlab-and-python-packages) for instructions on installing the plugin to the right location. -- Otherwise, we recommend using Jupyter within a virtual environment using -`virtualenv`. See the [Running Jupyter in a virtualenv](#running-jupyter-in-a-virtualenv), shown below, for instructions -on setting up a `virtualenv`, or read more at the -[virtualenv documentation](https://virtualenv.pypa.io/en/latest/). -The following commands should be run after activating the Python environment where you plan to use `jupyter`. +Once you complete the installation instructions, please return to this document for additional information such as upgrading or usage instructions. -- Install the `rsconnect-jupyter` package with the following command: -
Terminal
- ```bash - pip install rsconnect_jupyter - ``` +--- -- Enable the `rsconnect-jupyter` extension with the following commands: -
Terminal
- ```bash - # Install `rsconnect-jupyter` as a jupyter extension - jupyter-nbextension install --sys-prefix --py rsconnect_jupyter +### Installing Jupyter within a virtual environment - # Enable JavaScript extension - jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter +- Otherwise, we recommend using Jupyter within a virtual environment using +`virtualenv`. See the [Running Jupyter in a virtualenv](#running-jupyter-in-a-virtualenv), shown below, for instructions +on setting up a `virtualenv`, or read more at the +[virtualenv documentation](https://virtualenv.pypa.io/en/latest/). - # Enable Python extension - jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter - ``` -!!! note - - The above commands only need to be run once when installing `rsconnect_jupyter`. - - In order to deploy content, you will need at least the [rsconnect-python](https://github.com/rstudio/rsconnect-python) package in every kernel you plan to deploy from. - - If you run into an issue during installation, please let us know by filing a bug [here](https://github.com/rstudio/rsconnect-jupyter/issues). - ### Running Jupyter in a virtualenv - These commands create and activate a `virtualenv` at `/my/path`: @@ -70,7 +135,9 @@ The following commands should be run after activating the Python environment whe pip install jupyter ``` -- [Install rsconnect-python](#installation) with your virtual environment active to install and activate the plugin for that copy of Jupyter. +- Install rsconnect-python with your virtual environment active to install and activate the plugin for that copy of Jupyter: + + --8<-- "snippets/python_pkg.md" !!! note Be sure to run Jupyter from this virtual environment, not from @@ -203,69 +270,7 @@ content location to publish to if the notebook title is the same. You may share notebooks if appropriate. -## Installation in JupyterHub - -In JupyterHub, follow the directions [above](#installation) to install the -`rsconnect-jupyter` package into the Python environment where the Jupyter -notebook server and kernel are installed. Typically those will be the same -environment. If you've configured separate kernel environments, install the -`rsconnect-jupyter` package in the notebook server environment as well as each -kernel environment. - -The exact install location depends on your Jupyterhub configuration. - -### JupyterHub Example Configuration - -This section presents a simple working example of a Jupyterhub configuration -with `rsconnect-jupyter` installed. -This example uses Docker, but you can install the `rsconnect-jupyter` package in -any Jupyterhub installation. Docker is not required. - -Example Dockerfile: - -

Dockerfile

-```dockerfile -FROM jupyterhub/jupyterhub:0.9.4 - -# Install Jupyter notebook into the existing base conda environment -RUN conda install notebook - -# Download and install rsconnect-jupyter in the same environment -# Update this to specify the desired version of the rsconnect-jupyter package, -# or pass `--build-arg VERSION=...` to docker build. -ARG VERSION=RSCONNECT_VERSION -ARG REPOSITORY=https://s3.amazonaws.com/rstudio-rsconnect-jupyter - -RUN wget ${REPOSITORY}/rsconnect_jupyter-${VERSION}-py2.py3-none-any.whl -RUN pip install rsconnect_jupyter-${VERSION}-py2.py3-none-any.whl && \ - jupyter-nbextension install --sys-prefix --py rsconnect_jupyter && \ - jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter && \ - jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter - -# create test users -RUN useradd -m -s /bin/bash user1 && \ - useradd -m -s /bin/bash user2 && \ - useradd -m -s /bin/bash user3 && \ - bash -c 'echo -en "password\npassword" | passwd user1' && \ - bash -c 'echo -en "password\npassword" | passwd user2' && \ - bash -c 'echo -en "password\npassword" | passwd user3' - -CMD ["jupyterhub"] -``` - -Run these commands to build and start the container: - -

Terminal

-```bash -docker build -t jupyterhub:rsconnect-jupyter . -docker run --rm -p 8000:8000 --name jupyterhub jupyterhub:rsconnect-jupyter -``` - -Connect to Jupyterhub on http://localhost:8000 and log in as one of the test -users. From there, you can create a notebook and publish it to RStudio Connect. -Note that the current Jupyterhub docker image uses Python 3.6.5, so you will -need a compatible Python version installed on your RStudio Connect server. ## Uninstalling diff --git a/docs/docs/snippets/python_pkg.md b/docs/docs/snippets/python_pkg.md new file mode 100644 index 00000000..64e3b6aa --- /dev/null +++ b/docs/docs/snippets/python_pkg.md @@ -0,0 +1,25 @@ +- The following commands should be run after activating the Python environment where you plan to use `jupyter`. + + - Install the `rsconnect-jupyter` package with the following command: +
Terminal
+ ```bash + pip install rsconnect_jupyter + ``` + + - Enable the `rsconnect-jupyter` extension with the following commands: +
Terminal
+ ```bash + # Install `rsconnect-jupyter` as a jupyter extension + jupyter-nbextension install --sys-prefix --py rsconnect_jupyter + + # Enable JavaScript extension + jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter + + # Enable Python extension + jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter + ``` + + !!! note + - The above commands only need to be run once when installing `rsconnect_jupyter`. + - In order to deploy content, you will need at least the [rsconnect-python](https://github.com/rstudio/rsconnect-python) package in every kernel you plan to deploy from. + - If you run into an issue during installation, please let us know by filing a bug [here](https://github.com/rstudio/rsconnect-jupyter/issues). \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e460412a..b36f1c50 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -24,6 +24,7 @@ markdown_extensions: - codehilite: guess_lang: false - pymdownx.tabbed + - pymdownx.details - pymdownx.snippets: base_path: 'docs/' check_paths: true From 4cc0740d7f5a025afbe2e6d246833c71cde6c6dc Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Tue, 6 Jul 2021 20:39:53 -0400 Subject: [PATCH 02/33] Update index.md --- docs/docs/index.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index bcc13913..4410befe 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -104,16 +104,15 @@ with `rsconnect-jupyter` installed. the [RStudio Server Pro documentation on Jupyter Notebooks](https://docs.rstudio.com/rsp/integration/jupyter-standalone/#4-install-jupyter-notebooks-jupyterlab-and-python-packages) for instructions on installing the plugin to the right location. -Once you complete the installation instructions, please return to this document for additional information such as upgrading or usage instructions. +- Once you complete the installation instructions, please return to this document for additional information such as upgrading or usage instructions. --- ### Installing Jupyter within a virtual environment -- Otherwise, we recommend using Jupyter within a virtual environment using -`virtualenv`. See the [Running Jupyter in a virtualenv](#running-jupyter-in-a-virtualenv), shown below, for instructions -on setting up a `virtualenv`, or read more at the -[virtualenv documentation](https://virtualenv.pypa.io/en/latest/). +- To install and use Jupyter within a virtual environment using +`virtualenv`, follow the [Running Jupyter in a virtualenv](#running-jupyter-in-a-virtualenv), shown below or read more at the +[Virtualenv](https://virtualenv.pypa.io/en/latest/) documentation. ### Running Jupyter in a virtualenv @@ -139,18 +138,18 @@ on setting up a `virtualenv`, or read more at the --8<-- "snippets/python_pkg.md" - !!! note - Be sure to run Jupyter from this virtual environment, not from - another installation, or the `rsconnect-python` extension will - not be available. To do so, you will need to activate the virtual - environment in each new terminal session before you run `jupyter`. +!!! important + Be sure to run Jupyter from this virtual environment, not from + another installation, or the `rsconnect-python` extension will + not be available. To do so, you will need to activate the virtual + environment in each new terminal session before you run `jupyter`. ## Upgrading To upgrade `rsconnect-jupyter`: -- First, uninstall the extension. -- Then, re-install it. +- First, [uninstall](#uninstalling) the extension. +- Then, reinstall it. ## Usage From 86838bbf688b0e56e7893cc7ab5e2b48ec0f01aa Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 09:57:15 -0400 Subject: [PATCH 03/33] Update index.md --- docs/docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index 4410befe..6a0b622a 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -17,16 +17,16 @@ The installation method depends on your Python environment that you are installing the `rsconnect-jupyter` package into. -This documentation covers three method: +This documentation covers three methods: -- [Installing in JupyterHub](#installing-in-jupyterhub) +- [Installation in JupyterHub](#installing-in-jupyterhub) - [Installing to Jupyter running on RStudio Workbench](#installing-to-jupyter-running-on-rstudio-workbench) - [Installing Jupyter within a virtual environment](#installing-jupyter-within-a-virtual-environment) Please skip to the installation section below that is best for your environment. -### Installing in JupyterHub +### Installation in JupyterHub In JupyterHub, follow these directions to install the `rsconnect-jupyter` package into the Python environment where the Jupyter From 3047d5c3b668c09c3c8e14103822527f774ecd51 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 09:59:24 -0400 Subject: [PATCH 04/33] Update index.md --- docs/docs/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index 6a0b622a..def83d41 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -20,19 +20,17 @@ The installation method depends on your Python environment that you are installi This documentation covers three methods: - [Installation in JupyterHub](#installing-in-jupyterhub) -- [Installing to Jupyter running on RStudio Workbench](#installing-to-jupyter-running-on-rstudio-workbench) +- [Installing `rsconnect-jupyter` to Jupyter running on RStudio Workbench](#installing-to-jupyter-running-on-rstudio-workbench) - [Installing Jupyter within a virtual environment](#installing-jupyter-within-a-virtual-environment) Please skip to the installation section below that is best for your environment. - ### Installation in JupyterHub In JupyterHub, follow these directions to install the `rsconnect-jupyter` package into the Python environment where the Jupyter notebook server and kernel are installed: - --8<-- "snippets/python_pkg.md" Typically those will be the same From 695452848db7c962ac2a225e1c060b545696b833 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 10:31:02 -0400 Subject: [PATCH 05/33] Update index.md --- docs/docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index def83d41..e0fa9ea8 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -23,7 +23,7 @@ This documentation covers three methods: - [Installing `rsconnect-jupyter` to Jupyter running on RStudio Workbench](#installing-to-jupyter-running-on-rstudio-workbench) - [Installing Jupyter within a virtual environment](#installing-jupyter-within-a-virtual-environment) -Please skip to the installation section below that is best for your environment. +Please navigate to the installation section below that is best for your environment. ### Installation in JupyterHub @@ -102,7 +102,7 @@ with `rsconnect-jupyter` installed. the [RStudio Server Pro documentation on Jupyter Notebooks](https://docs.rstudio.com/rsp/integration/jupyter-standalone/#4-install-jupyter-notebooks-jupyterlab-and-python-packages) for instructions on installing the plugin to the right location. -- Once you complete the installation instructions, please return to this document for additional information such as upgrading or usage instructions. +- Once you complete the installation instructions, please return to this document for additional information such as [Upgrading](#upgrading) or [Usage](#usage) instructions. --- From c27b1dfa1697ad09ee5998a28d3ccc789620b90d Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 10:46:06 -0400 Subject: [PATCH 06/33] Adding new ball icon --- docs/docs/images/rstudio-logo.png | Bin 5043 -> 0 bytes docs/docs/images/rstudio-logo.svg | 45 ++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) delete mode 100644 docs/docs/images/rstudio-logo.png create mode 100644 docs/docs/images/rstudio-logo.svg diff --git a/docs/docs/images/rstudio-logo.png b/docs/docs/images/rstudio-logo.png deleted file mode 100644 index f81a972465db5e842112cf6ef2f439fbc1bb8ad0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5043 zcmV;k6HM%hP)p8%ZPM5KOQa6R1tGKEe?wQVzB? zKo*>>N^OV}NLVVC?ZDPfHgRmr1_G6EWH*~F=cn;b$+wLx z`OtmL^xN;XJn|gfqn=jJOt;jps;j%-@xTB5@9TH|?{7vU)cJSug1(DKD?>7`WSm!$ z%%^gR6%g?PlBs|g?u2(v9z6HpxdWo;V7POVl{<0XLL>z_v7m=?f_~r3^CMJT#708F z{DBjbx>(;LPJ9vLG#8aUhZ9XtL)icfc8D=L2#~y)L%BQG`(~a>Lp~WNX-gpZ1I-1U zQu{yPOJ9OYUxF`o9x5g)WkCya7y#VC$hFgxm%H2l<>>&6{ajXrXGBadzQ=PK8iRKd zV_!q1-;FPRj1fBNOaoBJXk&Lls9TE)3+h+jF|{+D`I$-E@<6DrYgoWJUx~`U9|bQm zv+!xA)d|qn0~}jDD=K#R89-uTXGtIg0^Ic;YrGGYzXr|jbrzPNF4h2s;SNK@Q#w%Od^RG1d%FJVj#)pQ~9~+@Agn_2*y-AozDR z<#xA*zRqPbi#6B+CJma9&1BX{*fG z3Ac;x->|&$?M$*QWh%4Pf#AK2%X^WZ1A?SN=QG1H-;J?THCoM#eW+>A=-Jo!*b^PW zr&0D*Nz3m9CP)CYi|rm7yD}4-U1UW;}oy!Tf|$IvzSDfUbi0y&HV9_vlPu zC|cTpu&%D@rZ5j}2M8t`;><~OMFNa^T}=ANjVrwMS3J#qO3N5wP2G_@LUL$_0|JvO zi_=(H<^hZw9x{ny0vXeRfSJMlvP`car~HK691p`1z@nQZbN<5W+Tat0i6lvADiDC! zN3c=!8|0UhBu^)3I1=FehXBK~X3r>08zWTLibWz>%nlrv2?;Rv;^wN#Z<>{rDJ_EN z4$yQxWfoHo9UT(j{GsaFBYqt*bwwF=i%=bCybasN+mV~o9q1CdxsjM8t*Tk!ePOs% zhXn+z6WkyZ-|g%f47VDLr^lib)ZaVps5Fq(L6{jrL$+`k8d!xE!3oOC8h z0P74yuG=gBzB&g4M#XM&I;=AgmjnK7LBk)VAt0RWXxQQ`8=G92 z!zRb4c7^z_{hS-B)07ionz#%zgolUCw?n{m31F;tTW4Kxtr5a0jS<$q)KnG@g+D-- zFu_P>PMS}zjr{8ig>dTm%BKVe!j^^&oj6tHqWn1)8Z>7UL3Xeq62_msSjO{PV}U=CSzN3j3B0qT$ZboB_2&-vnJ=#!%IrZcVh`!9dlZoOvw)o=s&LuoGDJ0pC%Bx z&IN@%g7RdEM_U-qC(?qlLi*;SQYt`eVIRly!mR6GlJTnwZJ`DQwX^+J=oaSBDxgXE zIW$pR82E|j3Ahhu93aLOePNmULb5U#%*EJ3T%ya->smYd>BTor(M1egZQ|Nc!dX~x zyrjmj>KI{NeIxc0vNu4CX7q#OiN^p%brt5h6mWcNacOk)!RKIe7kzT3i`sfZ)Ycuw z6{2=L_W=ZGDifT*K=HU7DxH{1*G|u;YjC-f3_2$lnef=Q_$P5olG}-3zN1KukLH1HxFOb zMbiS2TJrPquY$p^u6SM&#t5tHkNlloKoDOTGvCFU!XG|3M=$O^rK~Y%(Y|BuB&BuI z3b&YlQCCm*J!(8900D|m52{5Rt$s}{J@lV%omR#ZYBI=iNi=_!jaJ?{SFPU|AP6H? z#F>~aI4(*8Vhv%(!3$A7v5$5F0>(49`U6cu0l!SU71cESYi)qzY5>h!HgAzD!THBDS*wnI-n}>tS*GBU@2!w8GUx=-^yy!sZ zIaUH^FZIQGM7`Mz2&igyXB7Ka#t7&ZmP7|Q&xsP~##S}V+9U?RM{H2p$)WXM9L?`w zi+}?&F#*w$oaZYN=h)46L)Aa9KNm*1%Y z5N%4?4MB@AuIv2K1raV3AoNi0LQEU4v<{I_=N=;gvFxn1+11gb-crO6u-FTiLrWqo zDU}~)vHe9P(7DG-psYxHEPc$58cduG4hIwHxOL+%0m_4YSkD}%LP6r` zW)Ws8OY&&x{9>AtWHagY{jIhfB*uwYsed<&=XmX+bQf0u(_e)izzf!HRfC8b^I8b3=L_avObjCd$f(}-)kN!nq9(``iD4J0j3dlVOlqzH&u)$ahd6a z8vLstwa`03<4Un+@?#P$Mb8cv;GLuHdIZ{l*})&7%z7rtR5oWhAfk2 zgoV2Sgb~^`d~&99NZSVD2;DR&o~pV25FZ^N5QRTi0w9b~_v`;Xi?ayHn>umc@q2g7 z!U2^;G2D9XB-#%hMLTXL8L3hUqS98)HA2xwX@r%OmoNZSbK=~iI0CO@HmR1}UVg>R zSZQXg-CkUq%kBPCo%9i`qNur&TsA^?HYs0MO5oU1y^tWVP1ZELNiCZ=uSLz=?kPcav$1E_mr=g96){&YMTFhUVZSF>vT0WWe zV@mx?_#gS<%w}x;-0HB!+%JwltGF-CoeYCsi3?CFQElOcu3-QO`7YUM5#p+>1s2m@ z-+w;Nci>ehu!>p4NO7|4QW^ruzpSzui%RxawK2J7gn_J+7u3z}Rutzc)>uu>GArb8 zQe&V+7|5MFtwLNiV0)GV?>1|me!dGztrP9vMYQ>S!t4WacU-Ilggt~^ zpInIby!&bDY1O=g&D|tUIH@_ibrG zAgr-pg2{h1H)m=-e(Yg=yUh6D4{lyQ`~B!L#4MVlVfz&<0jXN=j!u-x=Vdn(8_I6! zykh0JTe8G^8ZOb9i>Wn&ik>63tN-Z>(^N@+8C`_={BlY(NAJ*D5t#uGL3{bqy5)^5}>coUXRQU!u2o3Oz8;fZ#dH#70;7gpDj@tk!a zC_e^ezlpD-!LC6BTpmUKK0cE3o+yErq30-6+-&IH!0&vH$MYQn1QCcPBB9xcPvpE4 zKp;cU(E`nUs+GZ*YW*evVS{h>9?(9JD*e$IU;J-V#7P z_HkG4mSm;S1j2XjV!a^nWU|Cgm`x(5plw;D*;Rye=t;QAh=Ho1QB7=ii%fo6PM#`CINKq2fY>E zpXgzGNFWFzV<`u%0#iT!qbC<9PIe^VV&8sf0aMqeiQ`BY5Psw?Pf*`oTcNI3H*u#2>JMpq2fz6w$D*u#f&M5&w5U;87{t{CX z)ve4_Gk4;fEdjPCzsUQz5vnNzL1f~g!fyc#&Ur~A5>Hba)W-$bLAp=u6B)_E5D@&n zk`A|R1H!~+*nj|2x zZ){%SeQh|@4Ff@By0L2ZZpK{?pjpBRLC0l90*oF92>xrhc@GN+BJ&zwMI8>%J~CWJ zob;(n03YB_H&@O6aq1}(Qw$pjf+S`V&tdNRqeSwKPr4+4^_+mG%4^z&peaBQg~in-;_;AiG_$=IMW*Hs6CV!`Pd=kN38$~8g_AKSB=R(K!9UEN?q zBw~tp(}5uJUsD^r4~8YS;&J4eDos(qW=6-D;E5Vv<$5z|Mrfr42!i<9+Q!?%JiHB$ zFx=(1;Yi@}tZWrP@blr&NtQNkKoFU(tvfnDEcc5872ae_IAPin!1jMDfbgJ^{R3^P zi6LnPg2>MQT5Dlf$N68NLlY~Jj!QuT7zezQlSB8d|4QYF6p|T=nsy*WxEdHl@+Sd^ zF%duKt|0;C#4>I16nnpKbnifevZi;&fFL+n8wlPYGai8bo(fHloPhJhq_1tR^1hl$ zQJA)lpoi&=zRJCx-2Cg%?}<}Xx^(IE&>b;xaQ-0Q&92Eb2!#AH+9E_(*t)>6&xWb* zIdl~Zqy0ze^8v}_TD56;#hckGf7XByDR6b*$b+1*E%-NWNyKjy-8-=~|L+y$-lz3y z8>dS)SqFkBnE$1w30{5|;1 zi1^#~j{jj`XW(Zpcka_0mX)?zu^g5JLPSu30C(+W4Y#9pScxg;QvBpTFA`?`I}2lW z^g0B*HLu9^2mj)7^}m2vq#%|CLbQwqRwyr35rtQxf4v2ROH1+&ruHe7PwwAZt@)3Z zXZ*7zg&EIe{QKj96Ei}r_lwYv`ywO01g%ABe4I?Zi@gB+R(TgAX{Y3-9UGQ;g~=h? zIa>lDUdpTM8fHrzfFN1~P|QW4Dlz-eHh&sVK<7IuJ%pJ}BcdMw0N-+vd*}M9vVCUj z2IyqR)Mz6D2=Nl}b1sEyk6qQzLZ5+s={Xo%%)wVX9r4Ct32hvnVKS8~&*))1ct-!t z+ELN%2!quz{3aRC5Dv_-i}M@&ki^`F%F4 + + + + + + + + + + + + + From dea0e4d3399106468b0df40d281a634a47e5940e Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 10:46:26 -0400 Subject: [PATCH 07/33] Ball icon and removing 'Intro" section in nav --- docs/mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b36f1c50..5ff7a245 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,7 +10,7 @@ google_analytics: - 'auto' nav: -- 'Introduction': 'index.md' +- '': 'index.md' markdown_extensions: @@ -37,7 +37,7 @@ plugins: theme: name: material custom_dir: overrides - logo: 'images/rstudio-logo.png' + logo: 'images/rstudio-logo.svg' palette: primary: 'white' From fa5b20d33491daac2bd12ae8cd7e06057a749da5 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 10:46:30 -0400 Subject: [PATCH 08/33] edits --- docs/docs/index.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index e0fa9ea8..26ae4b12 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -104,7 +104,7 @@ for instructions on installing the plugin to the right location. - Once you complete the installation instructions, please return to this document for additional information such as [Upgrading](#upgrading) or [Usage](#usage) instructions. ---- +--- ### Installing Jupyter within a virtual environment @@ -112,7 +112,6 @@ for instructions on installing the plugin to the right location. `virtualenv`, follow the [Running Jupyter in a virtualenv](#running-jupyter-in-a-virtualenv), shown below or read more at the [Virtualenv](https://virtualenv.pypa.io/en/latest/) documentation. - ### Running Jupyter in a virtualenv - These commands create and activate a `virtualenv` at `/my/path`: @@ -123,7 +122,7 @@ for instructions on installing the plugin to the right location. source /my/path/bin/activate ``` -!!! tip +!!! tip Running `source /my/path/bin/activate` activates the virtual environment. While the `virtualenv` is active, Python-related commands like `python`, `pip`, and `jupyter` will use to copies located inside the virtual environment. You can check which copy of `python` you're using by running `which python`. - Install Jupyter inside the `virtualenv`: @@ -267,8 +266,6 @@ content location to publish to if the notebook title is the same. You may share notebooks if appropriate. - - ## Uninstalling - First disable and remove the `rsconnect-jupyter` notebook extension: @@ -287,8 +284,7 @@ You may share notebooks if appropriate. pip uninstall rsconnect_jupyter ``` - ## Related Documentation For a step-by-step guide for creating and publishing a new Jupyter Notebook to -RStudio Connect, view our [How To](https://docs.rstudio.com/how-to-guides/users/basic/publish-jupyter-notebook/). \ No newline at end of file +RStudio Connect, view our [How To Publish a Jupyter Notebook to RStudio Connect](https://docs.rstudio.com/how-to-guides/users/basic/publish-jupyter-notebook/). \ No newline at end of file From db810aaa3ed30bbc89180eea3920c6a92547f511 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 10:55:19 -0400 Subject: [PATCH 09/33] Breaking up content --- docs/docs/additional-info.md | 4 + docs/docs/collaboration.md | 7 ++ docs/docs/index.md | 148 ----------------------------------- docs/docs/uninstalling.md | 17 ++++ docs/docs/upgrading.md | 6 ++ docs/docs/usage.md | 109 ++++++++++++++++++++++++++ docs/mkdocs.yml | 8 +- 7 files changed, 149 insertions(+), 150 deletions(-) create mode 100644 docs/docs/additional-info.md create mode 100644 docs/docs/collaboration.md create mode 100644 docs/docs/uninstalling.md create mode 100644 docs/docs/upgrading.md create mode 100644 docs/docs/usage.md diff --git a/docs/docs/additional-info.md b/docs/docs/additional-info.md new file mode 100644 index 00000000..6380a72b --- /dev/null +++ b/docs/docs/additional-info.md @@ -0,0 +1,4 @@ +# Additional Information + +For a step-by-step guide for creating and publishing a new Jupyter Notebook to +RStudio Connect, view our [How To Publish a Jupyter Notebook to RStudio Connect](https://docs.rstudio.com/how-to-guides/users/basic/publish-jupyter-notebook/). \ No newline at end of file diff --git a/docs/docs/collaboration.md b/docs/docs/collaboration.md new file mode 100644 index 00000000..db475b39 --- /dev/null +++ b/docs/docs/collaboration.md @@ -0,0 +1,7 @@ +# Collaboration + +To collaborate with others add them as collaborators in RStudio Connect. During +publishing they should provide their API key and will be able to choose a +content location to publish to if the notebook title is the same. + +You may share notebooks if appropriate. \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/index.md index 26ae4b12..ede83654 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -140,151 +140,3 @@ for instructions on installing the plugin to the right location. another installation, or the `rsconnect-python` extension will not be available. To do so, you will need to activate the virtual environment in each new terminal session before you run `jupyter`. - -## Upgrading - -To upgrade `rsconnect-jupyter`: - -- First, [uninstall](#uninstalling) the extension. -- Then, reinstall it. - -## Usage - -To publish to RStudio Connect: - -- Open a notebook. -- Click the blue toolbar icon used for publishing the notebook icon (blue publish icon) and select `Publish to RStudio Connect` -to publish the current notebook to RStudio Connect. - -### Entering server information - -- If this is your first time publishing a notebook, you will be -prompted to enter the location and a nickname for the RStudio Connect server. -- You will also be prompted to enter your API Key. See the [RStudio Connect User -Guide](http://docs.rstudio.com/connect/user/api-keys.html) for -instructions on generating API Keys for your user. -- When you click the **Add Server** button, `rsconnect-jupyter` will send a request to the RStudio Connect server to verify that it can be reached via the requested URL and that the API key is valid. - -If your RStudio Connect server was configured with a self-signed certificate (or other certificate that computer hosting your Jupyter notebook server does not trust), the attempt to contact RStudio Connect may fail with a TLS-related error. - -You have multiple options in this case, depending on your needs: - -1. If your RStudio Connect Administrator can give you the Certificate Authority (CA) - Bundle for your RStudio Connect server, ask your Jupyter Administrator if it - can be added to the trusted system store. -1. If the CA Bundle cannot be added to the trusted system store, you may select - `Upload TLS Certificate Bundle` to upload the bundle to Jupyter, which will verify - your secure connection to RStudio Connect. -1. If you cannot obtain the CA bundle, you can disable TLS verification completely - by selecting the `Disable TLS Certificate Verification` box. Your connection to - RStudio Connect will still be encrypted, but you will not be able to verify the - identity of the RStudio Connect server. - -initial dialog that prompts for the location of RStudio Connect - -### Publishing options - -publish dialog - -There are two different publication modes. Selecting **Publish finished document only** will -publish an HTML snapshot of the notebook to RStudio Connect. HTML snapshots are static and -cannot be scheduled or re-run on the RStudio Connect server. - -If you select **Publish document with source code**, the notebook file and a list of the Python -packages installed in your environment will be sent to RStudio Connect. This enables RStudio -Connect to recreate the environment and re-run the notebook at a later time. - -#### Additional Files - -If your notebook needs some external file in order to render, add the file using the -**Select Files** button. You can select any file within the notebook folder. However, -these files may not be made available to users after render. - -#### Environment detection with pip - -The list of packages sent along with the notebook comes from the python -environment where the notebook kernel is running. In order for environment -inspection to work, the `rsconnect-jupyter` package must be installed in the -kernel environment; that is, the environment where the `ipykernel` package is -installed. In most cases that will be the same as the notebook server -environment where `jupyter` is installed. - -The command `pip freeze` will be used to inspect the environment. The output -of `pip freeze` lists all packages currently installed, as well as their -versions, which enables RStudio Connect to recreate the same environment. - -### Generating Manifests for git Publishing - -RStudio Connect can poll git repositories for deployable content and update -as you add new commits to your repository. In order to be deployable, a -directory must have a valid `manifest.json`. Python content should also have -some kind of environment file (i.e.: `requirements.txt`) in order to be able -to restore the package set in your current environment. - -Deployment drop-down -menu showing - -To begin, select `Create Manifest for git Publishing`. - -Dialog titled - -When you click **Create Manifest**, one of the following will happen: - -- If a `manifest.json` and `requirements.txt` does not exist, they will be generated for the current notebook using your current environment. -- If they do exist, you will be presented with a message -informing you of this fact. If you need to regenerate the files, delete them in the Jupyter UI or using the console, then repeat this process. - -For more information on git publishing, see the -[RStudio Connect User Guide](https://docs.rstudio.com/connect/user/git-backed.html#git-backed-publishing). - -### Handling conflicts - -If content that matches your notebook's title is found on RStudio Connect, you -may choose to overwrite the existing content or create new content. - -dialog that prompts for overwriting or publishing new content - -- Choosing **New location** creates a new document in RStudio Connect. -- You can choose either publication mode: - - an HTML snapshot *or* - - a document with source code - -Updating an existing document will not change its publication mode. - -Upon successful publishing of the document a notification will be -shown in toolbar. Clicking the notification will open the published -document in the RStudio Connect server you selected in the previous -dialog. - -notification that shows the notebook was published successfully - -## Collaboration - -To collaborate with others add them as collaborators in RStudio Connect. During -publishing they should provide their API key and will be able to choose a -content location to publish to if the notebook title is the same. - -You may share notebooks if appropriate. - -## Uninstalling - -- First disable and remove the `rsconnect-jupyter` notebook extension: -
Terminal
- ```bash - # Disable Python extensions found in `rsconnect-jupyter` - jupyter-serverextension disable --sys-prefix --py rsconnect_jupyter - - # Remove JavaScript extension - jupyter-nbextension uninstall --sys-prefix --py rsconnect_jupyter - ``` - -- Finally, uninstall the `rsconnect-jupyter` python package: -
Terminal
- ```bash - pip uninstall rsconnect_jupyter - ``` - -## Related Documentation - -For a step-by-step guide for creating and publishing a new Jupyter Notebook to -RStudio Connect, view our [How To Publish a Jupyter Notebook to RStudio Connect](https://docs.rstudio.com/how-to-guides/users/basic/publish-jupyter-notebook/). \ No newline at end of file diff --git a/docs/docs/uninstalling.md b/docs/docs/uninstalling.md new file mode 100644 index 00000000..e3e71758 --- /dev/null +++ b/docs/docs/uninstalling.md @@ -0,0 +1,17 @@ +# Uninstalling + +- First disable and remove the `rsconnect-jupyter` notebook extension: +
Terminal
+ ```bash + # Disable Python extensions found in `rsconnect-jupyter` + jupyter-serverextension disable --sys-prefix --py rsconnect_jupyter + + # Remove JavaScript extension + jupyter-nbextension uninstall --sys-prefix --py rsconnect_jupyter + ``` + +- Finally, uninstall the `rsconnect-jupyter` python package: +
Terminal
+ ```bash + pip uninstall rsconnect_jupyter + ``` \ No newline at end of file diff --git a/docs/docs/upgrading.md b/docs/docs/upgrading.md new file mode 100644 index 00000000..ecd360c0 --- /dev/null +++ b/docs/docs/upgrading.md @@ -0,0 +1,6 @@ +# Upgrading + +To upgrade `rsconnect-jupyter`: + +- First, [uninstall](#uninstalling) the extension. +- Then, reinstall it. \ No newline at end of file diff --git a/docs/docs/usage.md b/docs/docs/usage.md new file mode 100644 index 00000000..4d680d5c --- /dev/null +++ b/docs/docs/usage.md @@ -0,0 +1,109 @@ +# Usage + +To publish to RStudio Connect: + +- Open a notebook. +- Click the blue toolbar icon used for publishing the notebook icon (blue publish icon) and select `Publish to RStudio Connect` +to publish the current notebook to RStudio Connect. + +## Entering server information + +- If this is your first time publishing a notebook, you will be +prompted to enter the location and a nickname for the RStudio Connect server. +- You will also be prompted to enter your API Key. See the [RStudio Connect User +Guide](http://docs.rstudio.com/connect/user/api-keys.html) for +instructions on generating API Keys for your user. +- When you click the **Add Server** button, `rsconnect-jupyter` will send a request to the RStudio Connect server to verify that it can be reached via the requested URL and that the API key is valid. + +If your RStudio Connect server was configured with a self-signed certificate (or other certificate that computer hosting your Jupyter notebook server does not trust), the attempt to contact RStudio Connect may fail with a TLS-related error. + +You have multiple options in this case, depending on your needs: + +1. If your RStudio Connect Administrator can give you the Certificate Authority (CA) + Bundle for your RStudio Connect server, ask your Jupyter Administrator if it + can be added to the trusted system store. +1. If the CA Bundle cannot be added to the trusted system store, you may select + `Upload TLS Certificate Bundle` to upload the bundle to Jupyter, which will verify + your secure connection to RStudio Connect. +1. If you cannot obtain the CA bundle, you can disable TLS verification completely + by selecting the `Disable TLS Certificate Verification` box. Your connection to + RStudio Connect will still be encrypted, but you will not be able to verify the + identity of the RStudio Connect server. + +initial dialog that prompts for the location of RStudio Connect + +## Publishing options + +publish dialog + +There are two different publication modes. Selecting **Publish finished document only** will +publish an HTML snapshot of the notebook to RStudio Connect. HTML snapshots are static and +cannot be scheduled or re-run on the RStudio Connect server. + +If you select **Publish document with source code**, the notebook file and a list of the Python +packages installed in your environment will be sent to RStudio Connect. This enables RStudio +Connect to recreate the environment and re-run the notebook at a later time. + +### Additional Files + +If your notebook needs some external file in order to render, add the file using the +**Select Files** button. You can select any file within the notebook folder. However, +these files may not be made available to users after render. + +### Environment detection with pip + +The list of packages sent along with the notebook comes from the python +environment where the notebook kernel is running. In order for environment +inspection to work, the `rsconnect-jupyter` package must be installed in the +kernel environment; that is, the environment where the `ipykernel` package is +installed. In most cases that will be the same as the notebook server +environment where `jupyter` is installed. + +The command `pip freeze` will be used to inspect the environment. The output +of `pip freeze` lists all packages currently installed, as well as their +versions, which enables RStudio Connect to recreate the same environment. + +## Generating Manifests for git Publishing + +RStudio Connect can poll git repositories for deployable content and update +as you add new commits to your repository. In order to be deployable, a +directory must have a valid `manifest.json`. Python content should also have +some kind of environment file (i.e.: `requirements.txt`) in order to be able +to restore the package set in your current environment. + +Deployment drop-down +menu showing + +To begin, select `Create Manifest for git Publishing`. + +Dialog titled + +When you click **Create Manifest**, one of the following will happen: + +- If a `manifest.json` and `requirements.txt` does not exist, they will be generated for the current notebook using your current environment. +- If they do exist, you will be presented with a message +informing you of this fact. If you need to regenerate the files, delete them in the Jupyter UI or using the console, then repeat this process. + +For more information on git publishing, see the +[RStudio Connect User Guide](https://docs.rstudio.com/connect/user/git-backed.html#git-backed-publishing). + +## Handling conflicts + +If content that matches your notebook's title is found on RStudio Connect, you +may choose to overwrite the existing content or create new content. + +dialog that prompts for overwriting or publishing new content + +- Choosing **New location** creates a new document in RStudio Connect. +- You can choose either publication mode: + - an HTML snapshot *or* + - a document with source code + +Updating an existing document will not change its publication mode. + +Upon successful publishing of the document a notification will be +shown in toolbar. Clicking the notification will open the published +document in the RStudio Connect server you selected in the previous +dialog. + +notification that shows the notebook was published successfully \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5ff7a245..5a9bba95 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,8 +10,12 @@ google_analytics: - 'auto' nav: -- '': 'index.md' - +- 'Installing': 'index.md' +- 'Upgrading': 'upgrading.md' +- 'Usage': 'usage.md' +- 'Collaboration': 'collaboration.md' +- 'Uninstalling': 'uninstalling.md' +- 'Addition Information': 'additional-info.md' markdown_extensions: - admonition From 1246413113b109ae127441074adbaa5c6418fafe Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 11:06:20 -0400 Subject: [PATCH 10/33] Putting uninstall content into snippet file I have to do this because the H1 doesn't render properly and breaks the right TOC. By breaking the content out into a snippet, I can use this content in both places without having to worry about a header mess --- docs/docs/snippets/uninstall.md | 15 +++++++++++++++ docs/docs/uninstalling.md | 16 +--------------- docs/docs/upgrading.md | 6 ++++-- 3 files changed, 20 insertions(+), 17 deletions(-) create mode 100644 docs/docs/snippets/uninstall.md diff --git a/docs/docs/snippets/uninstall.md b/docs/docs/snippets/uninstall.md new file mode 100644 index 00000000..6ee36390 --- /dev/null +++ b/docs/docs/snippets/uninstall.md @@ -0,0 +1,15 @@ +- Disable and remove the `rsconnect-jupyter` notebook extension: +
Terminal
+ ```bash + # Disable Python extensions found in `rsconnect-jupyter` + jupyter-serverextension disable --sys-prefix --py rsconnect_jupyter + + # Remove JavaScript extension + jupyter-nbextension uninstall --sys-prefix --py rsconnect_jupyter + ``` + +- Finally, uninstall the `rsconnect-jupyter` python package: +
Terminal
+ ```bash + pip uninstall rsconnect_jupyter + ``` \ No newline at end of file diff --git a/docs/docs/uninstalling.md b/docs/docs/uninstalling.md index e3e71758..92b2bc7e 100644 --- a/docs/docs/uninstalling.md +++ b/docs/docs/uninstalling.md @@ -1,17 +1,3 @@ # Uninstalling -- First disable and remove the `rsconnect-jupyter` notebook extension: -
Terminal
- ```bash - # Disable Python extensions found in `rsconnect-jupyter` - jupyter-serverextension disable --sys-prefix --py rsconnect_jupyter - - # Remove JavaScript extension - jupyter-nbextension uninstall --sys-prefix --py rsconnect_jupyter - ``` - -- Finally, uninstall the `rsconnect-jupyter` python package: -
Terminal
- ```bash - pip uninstall rsconnect_jupyter - ``` \ No newline at end of file +--8<-- "snippets/uninstall.md" \ No newline at end of file diff --git a/docs/docs/upgrading.md b/docs/docs/upgrading.md index ecd360c0..9324f0d8 100644 --- a/docs/docs/upgrading.md +++ b/docs/docs/upgrading.md @@ -2,5 +2,7 @@ To upgrade `rsconnect-jupyter`: -- First, [uninstall](#uninstalling) the extension. -- Then, reinstall it. \ No newline at end of file +- First, uninstall the extension: + --8<-- "snippets/uninstall.md" + +- Then, reinstall it. From 9c04b5c5fb8a56de4595b32a7f56cf887a341e5a Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 11:06:30 -0400 Subject: [PATCH 11/33] Fixing links --- docs/docs/index.md | 2 +- docs/docs/usage.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index ede83654..51fb0bfa 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -102,7 +102,7 @@ with `rsconnect-jupyter` installed. the [RStudio Server Pro documentation on Jupyter Notebooks](https://docs.rstudio.com/rsp/integration/jupyter-standalone/#4-install-jupyter-notebooks-jupyterlab-and-python-packages) for instructions on installing the plugin to the right location. -- Once you complete the installation instructions, please return to this document for additional information such as [Upgrading](#upgrading) or [Usage](#usage) instructions. +- Once you complete the installation instructions, please return to this document for additional information such as [Upgrading](/upgrading) or [Usage](/usage) instructions. --- diff --git a/docs/docs/usage.md b/docs/docs/usage.md index 4d680d5c..dc02f9be 100644 --- a/docs/docs/usage.md +++ b/docs/docs/usage.md @@ -3,7 +3,7 @@ To publish to RStudio Connect: - Open a notebook. -- Click the blue toolbar icon used for publishing the notebook icon (blue publish icon) and select `Publish to RStudio Connect` +- Click the blue toolbar icon used for publishing the notebook icon (blue publish icon) and select `Publish to RStudio Connect` to publish the current notebook to RStudio Connect. ## Entering server information From 09bef775d1e89d500aaffbc7df61b06808f23fbf Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Wed, 7 Jul 2021 11:10:07 -0400 Subject: [PATCH 12/33] Fixing footer and adding updated css --- docs/docs/css/custom.css | 13 ++-- docs/mkdocs.yml | 2 +- docs/overrides/partials/footer.html | 93 +++++++++++++---------------- 3 files changed, 51 insertions(+), 57 deletions(-) diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index e07916a9..71ca24e9 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -92,12 +92,12 @@ background-color: #4c83b6; } -.md-footer-nav { - background-color: #fff; - color: #000; +.md-footer { + background-color: #fff !important; + color: #000 !important; } -.md-footer-nav__direction { +.md-footer__direction { color: #000; font-size: .65rem; } @@ -119,6 +119,11 @@ font-weight: 400; } +.md-footer-nav { + background-color: #fff; + color: #000; +} + .md-typeset .tabbed-set>label { font-size: .64rem !important; } diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5a9bba95..bc682783 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -15,7 +15,7 @@ nav: - 'Usage': 'usage.md' - 'Collaboration': 'collaboration.md' - 'Uninstalling': 'uninstalling.md' -- 'Addition Information': 'additional-info.md' +- 'Additional Information': 'additional-info.md' markdown_extensions: - admonition diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html index 9be29411..2a7ec2de 100644 --- a/docs/overrides/partials/footer.html +++ b/docs/overrides/partials/footer.html @@ -7,66 +7,55 @@