Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
Port website fixes (#20993, #20995, #21009) from v1.9.x branch (#21015)
Browse files Browse the repository at this point in the history 
* [v1.9.x] Update website footer to include required Apache links (#20993)

* Update footer to include required Apache links, according to https://www.apache.org/foundation/marks/pmcs#navigation

* Better layout with col-3 class.

* Fix 'module 'jinja2' has no attribute 'contextfilter''

* Update Makefile

* Update Makefile

Co-authored-by: Bartosz Kuncer <bartosz.kuncer@intel.com>

* [v1.9.x] Fix css for Apache links, add to Python docs. (#20995)

* Add Apache links to python docs footer, update hostname in CI script.

* Don't use relative_url function.

* Add link to ASF.

* Fix medium blog integration. (#21009)

* Update broken links to fix linkcheck.

Co-authored-by: Bartosz Kuncer <bartosz.kuncer@intel.com>
Co-authored-by: matherit <97054789+matherit@users.noreply.github.com>
  • Loading branch information
@josephevans @bartekkuncer @matherit
3 people committed May 17, 2022
1 parent eb8982d commit 0208063
Show file tree
Hide file tree
Showing 12 changed files with 79 additions and 77 deletions.
19 changes: 15 additions & 4 deletions docs/python_docs/themes/mx-theme/mxtheme/footer.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<footer class="site-footer h-card">
<div class="wrapper">
<div class="row">
<div class="col-4">
<div class="col-3">
<h4 class="footer-category-title">Resources</h4>
<ul class="contact-list">
<li><a
Expand All @@ -14,11 +14,22 @@ <h4 class="footer-category-title">Resources</h4>

</ul>
</div>
<div class="col-3">
<h4 class="footer-category-title">Apache</h4>
<ul class="apache-list">
<li><a href="https://www.apache.org/foundation/">Foundation</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="/api/faq/security.html">Security</a></li>
<li><a href="https://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/events/current-event">Events</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
</ul>
</div>

<div class="col-4"><ul class="social-media-list"><li><a href="https://github.com/apache/incubator-mxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#github', 1)}}"></use></svg> <span class="username">apache/incubator-mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#twitter', 1)}}"></use></svg> <span class="username">apachemxnet</span></a></li><li><a href="https://youtube.com/apachemxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#youtube', 1)}}"></use></svg> <span class="username">apachemxnet</span></a></li></ul>
<div class="col-3"><ul class="social-media-list"><li><a href="https://github.com/apache/incubator-mxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#github', 1)}}"></use></svg> <span class="username">apache/incubator-mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#twitter', 1)}}"></use></svg> <span class="username">apachemxnet</span></a></li><li><a href="https://youtube.com/apachemxnet"><svg class="svg-icon"><use xlink:href="{{pathto('_static/minima-social-icons.svg#youtube', 1)}}"></use></svg> <span class="username">apachemxnet</span></a></li></ul>
</div>

<div class="col-4 footer-text">
<div class="col-3 footer-text">
<p>A flexible and efficient library for deep learning.</p>
</div>
</div>
Expand All @@ -32,7 +43,7 @@ <h4 class="footer-category-title">Resources</h4>
<img src="{{pathto('_static/apache_incubator_logo.png', 1)}}" class="footer-logo col-2">
</div>
<div class="footer-bottom-warning col-9">
<p>Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <span style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required
<p>Apache MXNet is an effort undergoing incubation at <a href="http://www.apache.org/">The Apache Software Foundation</a> (ASF), <span style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required
of all newly accepted projects until a further review indicates that the infrastructure,
communications, and decision making process have stabilized in a manner consistent with other
successful ASF projects. While incubation status is not necessarily a reflection of the completeness
Expand Down
1 change: 1 addition & 0 deletions docs/python_docs/themes/mx-theme/src/scss/footer/_footer.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ footer.mdl-mini-footer {
}

.contact-list,
.apache-list,
.social-media-list {
list-style: none;
margin-left: 0;
Expand Down
5 changes: 5 additions & 0 deletions docs/static_site/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ all: html
html:
mkdir -p build
wget -O src/assets/js/jquery-3.3.1.min.js https://code.jquery.com/jquery-3.3.1.min.js
wget -O src/assets/img/mxnet-icon.png https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png
wget -O src/assets/docsearch.min.css 'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css'
wget -O src/assets/js/docsearch.min.js 'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js'
wget -O src/assets/retainable.css https://www.twilik.com/assets/retainable/rss-embed/retainable.css
wget -O src/assets/js/retainable.js https://www.twilik.com/assets/retainable/rss-embed/retainable.js
cd src && bundle install && JEKYLL_ENV=production bundle exec jekyll build --config _config_prod.yml -d ../build/html && cd ..
wget https://mxnet-website-static-artifacts.s3.us-east-2.amazonaws.com/versions.zip && unzip versions.zip -d build/html
find build/html/ -type d -name '__MACOSX' -exec rm -rf {} +
Expand Down
22 changes: 16 additions & 6 deletions docs/static_site/src/_includes/footer.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<footer class="site-footer h-card">
<div class="wrapper">
<div class="row">
<div class="col-4">
<div class="col-3">
<h4 class="footer-category-title">Resources</h4>
<ul class="contact-list">
<li><a href="{{'community#stay-connected'|relative_url}}">Mailing lists</a></li>
Expand All @@ -10,15 +10,25 @@ <h4 class="footer-category-title">Resources</h4>
<li><a href="https://github.com/apache/incubator-mxnet/projects">Projects</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li>
<li><a href="{{'community'|relative_url}}">Contribute To MXNet</a></li>

</ul>
</div>
<div class="col-3">
<h4 class="footer-category-title">Apache</h4>
<ul class="apache-list">
<li><a href="https://www.apache.org/foundation/">Foundation</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="{{'/api/faq/security.html' | relative_url }}">Security</a></li>
<li><a href="https://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/events/current-event">Events</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
</ul>
</div>

<div class="col-4">
<div class="col-3">
{%- include social.html -%}
</div>

<div class="col-4 footer-text">
<div class="col-3 footer-text">
<p>{{- site.description | escape -}}</p>
</div>
</div>
Expand All @@ -31,13 +41,13 @@ <h4 class="footer-category-title">Resources</h4>
<img src="{{'/assets/img/apache_incubator_logo.png' | relative_url}}" class="footer-logo col-2">
</div>
<div class="footer-bottom-warning col-9">
<p>Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <span
<p>Apache MXNet is an effort undergoing incubation at <a href="http://www.apache.org/">The Apache Software Foundation</a> (ASF), <span
style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required
of all newly accepted projects until a further review indicates that the infrastructure,
communications, and decision making process have stabilized in a manner consistent with other
successful ASF projects. While incubation status is not necessarily a reflection of the completeness
or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</p><p>"Copyright © 2017-2018, The Apache Software Foundation Apache MXNet, MXNet, Apache, the Apache
</p><p>"Copyright © 2017-2022, The Apache Software Foundation Apache MXNet, MXNet, Apache, the Apache
feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the
Apache Software Foundation."</p>
</div>
Expand Down
16 changes: 11 additions & 5 deletions docs/static_site/src/_includes/head.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,27 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png">
<link href="{{ "/assets/img/mxnet-icon.png" | relative_url }}" rel="icon" type="image/png">
{%- seo -%}
<script src="https://medium-widget.pixelpoint.io/widget.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
{%- if jekyll.environment == 'production' -%}
<link rel="stylesheet" href="{{ "/assets/docsearch.min.css" | relative_url }}" />
<link rel="stylesheet" href="{{ "/assets/retainable.css" | relative_url }}" />
{%- else -%}
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<link rel="stylesheet" href="https://www.twilik.com/assets/retainable/rss-embed/retainable.css" />
{%- endif -%}
<link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
{%- feed_meta -%}
{%- if jekyll.environment == 'production' and site.google_analytics -%}
{%- include google-analytics.html -%}
{%- endif -%}
{%- if jekyll.environment == 'production' -%}
<script src="{{'/assets/js/jquery-3.3.1.min.js'|relative_url}}"></script>
<script src="{{ "/assets/js/docsearch.min.js" | relative_url }}"></script>
{%- else -%}
<script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js" defer></script>
{%- endif -%}
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js" defer></script>
<script src="{{'/assets/js/globalSearch.js'|relative_url}}" defer></script>
<script src="{{'/assets/js/clipboard.js'|relative_url}}" defer></script>
<script src="{{'/assets/js/copycode.js'|relative_url}}" defer></script>
Expand Down
24 changes: 11 additions & 13 deletions docs/static_site/src/_layouts/home.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,19 +131,11 @@ <h2>Latest News</h2>
</div>
</div>

<div id="medium-widget"></div>
<script>
MediumWidget.Init({renderTo: '#medium-widget',
params: {
"resource": "https://medium.com/apache-mxnet",
"postsPerLine": 3,
"limit": 3,
"picture": "big",
"fields": ["description", "claps", "publishAt"],
"ratio": "landscape"
}
})
</script>
<div class="row" id="retainable-rss-embed" data-rss="https://medium.com/feed/apache-mxnet"
data-maxcols="3" data-layout="slider" data-poststyle="external"
data-readmore="Read more.." data-buttonclass="btn btn-primary">
</div>

</div>
</div>

Expand Down Expand Up @@ -182,6 +174,12 @@ <h3>{{feature.title}}</h3>

{%- include footer.html -%}

{%- if jekyll.environment == 'production' -%}
<script src="{{ "/assets/js/retainable.js" | relative_url }}"></script>
{%- else -%}
<script src="https://www.twilik.com/assets/retainable/rss-embed/retainable.js"></script>
{%- endif -%}

</body>

</html>
34 changes: 5 additions & 29 deletions docs/static_site/src/_sass/minima/_blog.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,13 @@
* specific language governing permissions and limitations
* under the License. */

.medium-widget-article__item {
transition: box-shadow 0.3s linear;

&:hover {
box-shadow: inset 0 -2px 0 0 $color-mxnet;
filter: none;
border-bottom: 1px white solid;

a.medium-widget-article__title {
color: orangered;
}
}

margin: 20px;
background-color: $grey-color-light;
padding: 0px;
border: 1px solid $grey-color-light
.page-content-home div#rtb h2 {
font-size: 0.6em;
}

.medium-widget-article__title {
font-weight: 300;
}

.medium-widget-article__content {
padding: 15px;
}

@include media-query($on-palm) {
.medium-widget-article__row {
flex-direction: column;
}
#rtb div.col-sm-4.rtb-col {
border: 1px solid $grey-color-light;
margin: 20px;
}

.blog-more {
Expand Down
1 change: 1 addition & 0 deletions docs/static_site/src/_sass/minima/_layout.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@
}

.contact-list,
.apache-list,
.social-media-list {
list-style: none;
margin-left: 0;
Expand Down
28 changes: 11 additions & 17 deletions docs/static_site/src/pages/blog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,18 @@
</div>
</div>

<div id="medium-widget"></div>
<script>

MediumWidget.Init({renderTo: '#medium-widget',
params: {
"resource": "https://medium.com/apache-mxnet",
"postsPerLine": 3,
"limit": 9,
"picture": "big",
"fields": ["description", "claps", "publishAt"],
"ratio": "landscape"
}
})


</script>

<div class="row">
<div class="col-12" id="retainable-rss-embed" data-rss="https://medium.com/feed/apache-mxnet"
data-maxcols="3" data-layout="grid" data-poststyle="external" data-readmore="Read more..">
</div>
</div>
<div class="blog-more">
<a style="margin-top:20px" href="https://medium.com/apache-mxnet" class="btn btn-action">See All Blog Posts<span class="span-accented">›</span></a>

</div>
{%- if jekyll.environment == 'production' -%}
<script src="{{ "/assets/js/retainable.js" | relative_url }}"></script>
{%- else -%}
<script src="https://www.twilik.com/assets/retainable/rss-embed/retainable.js"></script>
{%- endif -%}

2 changes: 1 addition & 1 deletion python/mxnet/ndarray/numpy_extension/_op.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -918,7 +918,7 @@ def rnn(data=None, parameters=None, state=None, state_cell=None, sequence_length
h_t = \tanh(W_{ih} * x_t + b_{ih} + W_{hh} * h_{(t-1)} + b_{hh})
Reference paper: Finding structure in time - Elman, 1988.
https://crl.ucsd.edu/~elman/Papers/fsit.pdf
https://axon.cs.byu.edu/~martinez/classes/678/Papers/Elman_time.pdf
**LSTM**
Expand Down
2 changes: 1 addition & 1 deletion python/mxnet/numpy_extension/_op.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ def rnn(data=None, parameters=None, state=None, state_cell=None, sequence_length
h_t = \tanh(W_{ih} * x_t + b_{ih} + W_{hh} * h_{(t-1)} + b_{hh})
Reference paper: Finding structure in time - Elman, 1988.
https://crl.ucsd.edu/~elman/Papers/fsit.pdf
https://axon.cs.byu.edu/~martinez/classes/678/Papers/Elman_time.pdf
**LSTM**
Expand Down
2 changes: 1 addition & 1 deletion src/operator/rnn.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ With Tanh activtion function:
h_t = \tanh(W_{ih} * x_t + b_{ih} + W_{hh} * h_{(t-1)} + b_{hh})
Reference paper: Finding structure in time - Elman, 1988.
https://crl.ucsd.edu/~elman/Papers/fsit.pdf
https://axon.cs.byu.edu/~martinez/classes/678/Papers/Elman_time.pdf
**LSTM**
Expand Down

0 comments on commit 0208063

Please sign in to comment.