Skip to content

Commit

Permalink
News
Browse files Browse the repository at this point in the history
Adding news file
Migrating content into news
Adding separator page
Adding partials
Adding styles
  • Loading branch information
AshleyHenry15 committed Aug 26, 2021
1 parent b328010 commit d7a1115
Show file tree
Hide file tree
Showing 7 changed files with 154 additions and 37 deletions.
37 changes: 36 additions & 1 deletion NEWS.md → docs/docs/NEWS.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,66 @@
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.


`rsconnect-jupyter` 1.3.2
--------------------------------------------------------------------------------
New

* Bump version of `rsconnect-python` used.

* Make sure Conda environments don't cause problems.


`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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
8 changes: 8 additions & 0 deletions docs/docs/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@
color: #2196f3;
}


.md-nav__item hr {
display: block;
height: 1px;
Expand Down Expand Up @@ -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
*/

Expand Down
1 change: 1 addition & 0 deletions docs/docs/separator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Separator page
4 changes: 3 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand Down
69 changes: 34 additions & 35 deletions docs/overrides/partials/footer.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{#-
Make footer navigation stops at separators
Remove mkdocs links
-#}
{% import "partials/language.html" as lang with context %}
<!-- Application footer -->
<footer class="md-footer">
<!-- Link to previous and/or next page -->
Make footer navigation stops at separators
Remove mkdocs links
-#}
{% import "partials/language.html" as lang with context %}

<!-- Application footer -->
<footer class="md-footer">

<!-- Link to previous and/or next page -->
{% if page.previous_page or page.next_page %}
<nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer.title') }}">

Expand Down Expand Up @@ -56,31 +56,30 @@
</nav>
</div>
{% endif %}

<!-- Further information -->
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">

<!-- Copyright and theme information -->
<div class="md-footer-copyright">
{% if config.copyright %}
<div class="md-footer-copyright__highlight">
Copyright &#169; <script type="text/javascript">
document.write(new Date().getFullYear());
</script>
{{ config.copyright }}
</div>
{% endif %}
<!-- powered by
<a href="https://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">
Material for MkDocs</a> -->
</div>

<!-- Social links -->
{% include "partials/social.html" %}

<!-- Further information -->
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">

<!-- Copyright and theme information -->
<div class="md-footer-copyright">
{% if config.copyright %}
<div class="md-footer-copyright__highlight">
Copyright &#169; <script type="text/javascript">
document.write(new Date().getFullYear());
</script>
{{ config.copyright }}
</div>
{% endif %}
<!-- powered by
<a href="https://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">
Material for MkDocs</a> -->
</div>

<!-- Social links -->
{% include "partials/social.html" %}
</div>
</footer>
</div>
</footer>
32 changes: 32 additions & 0 deletions docs/overrides/partials/nav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{#-
Modified to have section dividers
-#}
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="__drawer">
<a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-nav__button md-logo">
{% if config.theme.logo.icon %}
<i class="md-icon">{{ config.theme.logo.icon }}</i>
{% else %}
<img src="{{ config.theme.logo | url }}" width="48" height="48">
{% endif %}
</a>
{{ config.site_name }}
</label>
{% if config.repo_url %}
<div class="md-nav__source">
{% include "partials/source.html" %}
</div>
{% endif %}
<ul class="md-nav__list" data-md-scrollfix>
{% for nav_item in nav %}
{% if nav_item.title != "──────────────" %}
{% set path = "nav-" + loop.index | string %}
{% set level = 1 %}
{% include "partials/nav-item.html" %}
{% else %}
<li class="md-nav__item"><hr></li>
{% endif %}
{% endfor %}
</ul>
</nav>

40 changes: 40 additions & 0 deletions docs/overrides/partials/toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{#-
Modified to handle hiding the TOC
-#}
{% import "partials/language.html" as lang with context %}
{% if page.meta.hide_toc %}
{% else %}
<nav class="md-nav md-nav--secondary">
{% set toc_ = page.toc %}
{% if toc_ | first is defined and "\x3ch1 id=" in page.content %}
{% set toc_ = (toc_ | first).children %}
{% endif %}
{% if toc_ | first is defined %}
<label class="md-nav__title" for="__toc">{{ lang.t("toc.title") }}</label>
<ul class="md-nav__list" data-md-scrollfix>
{% for toc_item in toc_ %}
{% include "partials/toc-item.html" %}
{% endfor %}
{% if page.meta.source and page.meta.source | length > 0 %}
<li class="md-nav__item">
<a href="#__source" title="{{ lang.t('meta.source') }}" class="md-nav__link md-nav__link--active">
{{ lang.t("meta.source") }}
</a>
</li>
{% endif %}
{% set disqus = config.extra.disqus %}
{% if page and page.meta and page.meta.disqus is string %}
{% set disqus = page.meta.disqus %}
{% endif %}
{% if not page.is_homepage and disqus %}
<li class="md-nav__item">
<a href="#__comments" title="{{ lang.t('meta.comments') }}" class="md-nav__link md-nav__link--active">
{{ lang.t("meta.comments") }}
</a>
</li>
{% endif %}
</ul>
{% endif %}
</nav>
{% endif %}

0 comments on commit d7a1115

Please sign in to comment.