From d7a1115d28ff3295a9ed0136be5ec253be0e4554 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Thu, 26 Aug 2021 10:06:38 -0400 Subject: [PATCH 1/2] News Adding news file Migrating content into news Adding separator page Adding partials Adding styles --- NEWS.md => docs/docs/NEWS.md | 37 +++++++++++++++- docs/docs/css/custom.css | 8 ++++ docs/docs/separator.md | 1 + docs/mkdocs.yml | 4 +- docs/overrides/partials/footer.html | 69 ++++++++++++++--------------- docs/overrides/partials/nav.html | 32 +++++++++++++ docs/overrides/partials/toc.html | 40 +++++++++++++++++ 7 files changed, 154 insertions(+), 37 deletions(-) rename NEWS.md => docs/docs/NEWS.md (95%) create mode 100644 docs/docs/separator.md create mode 100644 docs/overrides/partials/nav.html create mode 100644 docs/overrides/partials/toc.html diff --git a/NEWS.md b/docs/docs/NEWS.md similarity index 95% rename from NEWS.md rename to docs/docs/NEWS.md index bdb3db6d..cb8677f0 100644 --- a/NEWS.md +++ b/docs/docs/NEWS.md @@ -1,24 +1,41 @@ +title: rsconnect-jupyter Release Notes + +# Introduction + +This document contains the release notes associated with each release of `rsconnect-jupyter`. + `rsconnect-jupyter` 1.4.2 -------------------------------------------------------------------------------- +New + * Added ability to hide all code cells when rendering Jupyter notebooks. * Added ability to selectively hide code cells tagged with 'hide_input' when rendering Jupyter notebooks. `rsconnect-jupyter` 1.4.1 -------------------------------------------------------------------------------- +New + * UI now shows more error details for troubleshooting. +* Bumped version of `rsconnect-python` used to 1.5.1. + +Fixed + * Fixed an issue where Windows 10 was not detecting `requirements.txt`. * Fixed an issue where older versions (around 5.4.0) of Jupyter notebook failed to recognize the presence of a `requirements.txt` file. -* Bumped version of `rsconnect-python` used to 1.5.1. `rsconnect-jupyter` 1.4.0 -------------------------------------------------------------------------------- +New + * Bump version of `rsconnect-python` used. `rsconnect-jupyter` 1.3.3 -------------------------------------------------------------------------------- +New + * Bump version of `rsconnect-python` used. * Manage cookies the right way. @@ -26,6 +43,8 @@ `rsconnect-jupyter` 1.3.2 -------------------------------------------------------------------------------- +New + * Bump version of `rsconnect-python` used. * Make sure Conda environments don't cause problems. @@ -33,11 +52,15 @@ `rsconnect-jupyter` 1.3.1 -------------------------------------------------------------------------------- +New + * Bump version of `rsconnect-python` used. `rsconnect-jupyter` 1.3.0 -------------------------------------------------------------------------------- +New + * Core functionality was moved to the `rsconnect-python` package, which includes a command-line interface for convenience. See https://github.com/rstudio/rsconnect-python for more information. @@ -58,12 +81,16 @@ `rsconnect-jupyter` 1.2.2.7 -------------------------------------------------------------------------------- +Fixed + * Fixed an issue where content could fail to deploy using old server configurations. The plugin will now delete any configuration without an associated API key, and you may have to add the configuration again. `rsconnect-jupyter` 1.2.2 -------------------------------------------------------------------------------- +New + * API key entry has been moved to the Add Server dialog. * API keys are validated by the server as part of Add Server. * API keys are now saved in the Jupyter configuration. @@ -77,12 +104,16 @@ `rsconnect-jupyter` 1.2.1 -------------------------------------------------------------------------------- +New + * pip is now invoked with `python -m pip` instead of looking for the pip executable * Always use `pip freeze` instead of pulling in requirements.txt. `rsconnect-jupyter` 1.2.0 -------------------------------------------------------------------------------- +New + * Renamed plugin from `rsconnect` to `rsconnect_jupyter` * Publish notebooks with source allowing them to be rendered on RStudio Connect. `pip` and `virtualenv` are used to determine dependent packages. @@ -91,10 +122,14 @@ `rsconnect-jupyter` 1.0.1 -------------------------------------------------------------------------------- +New + * Ensure json is decoded as utf-8 `rsconnect-jupyter` 1.0.0 -------------------------------------------------------------------------------- +New + * Initial release * Publish notebooks as pre-rendered static documents diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index f400905e..c375538b 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -152,6 +152,7 @@ color: #2196f3; } + .md-nav__item hr { display: block; height: 1px; @@ -370,6 +371,13 @@ figure.driver-card { list-style-type: square; } +/* Permalinks +*/ + +.md-typeset .headerlink:focus, .md-typeset:hover .headerlink, .md-typeset:target .headerlink { + color: #ccc !important; +} + /* Image Styles */ diff --git a/docs/docs/separator.md b/docs/docs/separator.md new file mode 100644 index 00000000..be6e5231 --- /dev/null +++ b/docs/docs/separator.md @@ -0,0 +1 @@ +# Separator page \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c6448a85..f315b475 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -15,12 +15,14 @@ nav: - 'Usage': 'usage.md' - 'Collaboration': 'collaboration.md' - 'Uninstalling': 'uninstalling.md' +- ──────────────: separator.md - 'Additional Resources': 'additional.md' +- 'Release Notes': 'NEWS.md' markdown_extensions: - admonition - toc: - permalink: true + permalink: "#" - attr_list: {} - def_list: {} - tables: {} diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html index 2a7ec2de..a9c6668e 100644 --- a/docs/overrides/partials/footer.html +++ b/docs/overrides/partials/footer.html @@ -1,13 +1,13 @@ {#- - Make footer navigation stops at separators - Remove mkdocs links - -#} - {% import "partials/language.html" as lang with context %} - - - diff --git a/docs/overrides/partials/nav.html b/docs/overrides/partials/nav.html new file mode 100644 index 00000000..76ec5c82 --- /dev/null +++ b/docs/overrides/partials/nav.html @@ -0,0 +1,32 @@ +{#- + Modified to have section dividers + -#} + + \ No newline at end of file diff --git a/docs/overrides/partials/toc.html b/docs/overrides/partials/toc.html new file mode 100644 index 00000000..5b3c45d6 --- /dev/null +++ b/docs/overrides/partials/toc.html @@ -0,0 +1,40 @@ +{#- + Modified to handle hiding the TOC + -#} + {% import "partials/language.html" as lang with context %} + {% if page.meta.hide_toc %} + {% else %} + + {% endif %} + \ No newline at end of file From ba0f1849d15108b40b6464eeeb302d8f7fc60d44 Mon Sep 17 00:00:00 2001 From: AshleyHenry15 Date: Thu, 26 Aug 2021 10:48:00 -0400 Subject: [PATCH 2/2] Update custom.css --- docs/docs/css/custom.css | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index c375538b..dc7c2daa 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -18,14 +18,16 @@ .md-tabs__list { margin: 0 2em 0 .2rem; - padding-top: .8rem; list-style: none; white-space: nowrap; } .md-tabs__link { - margin: 0; - padding: 0; + margin-top: auto !important; +} + +.md-tabs__item { + height: 1.75rem !important; } /* Search bar