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

Commit

Permalink
add error artifacts for local build
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmarkham committed Jan 23, 2019
1 parent 764704f commit 0b00237
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 40 deletions.
1 change: 0 additions & 1 deletion docs/build_version_doc/artifacts/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ RewriteRule ^get_started/why_mxnet.html$ %{ENV:default_version}/faq/why_mxnet.ht
RewriteRule ^get_started.*$ %{ENV:default_version}/install/ [R=301,L]
RewriteRule ^how_to.*$ %{ENV:default_version}/faq/ [R=301,L]
RewriteRule ^api/python/symbol.html$ %{ENV:default_version}/api/python/symbol/symbol.html [R=301,L]
RewriteRule ^(?:versions\/[^\/]+\/)?community/index.html$ %{ENV:default_version}/community/contribute.html [R=301,L]

# Navigation bar redirects to latest info
RewriteCond %{ENV:default_version}#\/$1 !^([^#]+)#\1$
Expand Down
2 changes: 1 addition & 1 deletion docs/build_version_doc/artifacts/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
</div>
<div>
<span id="page-does-not-exist"></span><h1>Page Does Not Exist</h1>
<p>If you’re here that means you requested a page that doesn’t exist. Sorry about that! Maybe try the search box to find what you’re looking for, or navigate to the <a href="https://mxnet.incubator.apache.org/index.html">Home Page</a>. Also, make sure you’re looking in the correct version, as some features may only be available in <a href="https://github.com/apache/incubator-mxnet/releases">newer versions</a> or the <a href="https://mxnet.incubator.apache.org/versions/master">master branch</a>.</p>
<p>If you’re here that means you requested a page that doesn’t exist. Sorry about that! Maybe try the search box to find what you’re looking for, or navigate to the <a href="/">Home Page</a>. Also, make sure you’re looking in the correct version, as some features may only be available in <a href="https://github.com/apache/incubator-mxnet/releases">newer versions</a> or the <a href="/versions/master">master branch</a>.</p>
</div>
</body>
</html>
32 changes: 0 additions & 32 deletions docs/build_version_doc/update_all_version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -78,27 +78,6 @@ for tag in $tag_list; do
echo "$tag" >> "$tag_file"
done

function update_mxnet_css {
tag=$1
echo "Begin update fixes.."
# All fixes are done on the master branch of mxnet-incubator repository
# During a nightly build, these fixes will be patched to all the versions in the asf-site repository including the master folder under versions directory.
# copy <master folder location> <version folder location>

echo "Copying mxnet.css from artifacts folder..."
cp "artifacts/mxnet.css" "$built/versions/$tag/_static"

echo "Update fixes complete.."
}

function update_error_pages {
tag=$1
# Static error pages avoid many issues with redirects and templating
echo "Copying error pages from artifacts folder..."
cp "artifacts/404.html" "$built/versions/$tag/error"
cp "artifacts/api.html" "$built/versions/$tag/error"
echo "Error copies complete..."
}

# Update the specified tags with the Versions dropdown
# Add various artifacts depending on the version
Expand All @@ -108,17 +87,6 @@ for tag in $tag_list; do

python AddVersion.py --root_url "$root_url" --file_path "$built/versions/$tag" --current_version "$tag" --tag_default "$tag_default" || exit 1

# Patch any fixes to all versions except 0.11.0.
# Version 0.11.0 has old theme and does not make use of the current mxnet.css
# It also has its install page in /getting_started, so we skip updating that
if [ $tag != '0.11.0' ]; then
if [ -d $built/versions/$tag ]; then
echo "The $tag is going to be updated with new css and install pages."
update_mxnet_css $tag
update_error_pages $tag
fi
fi

# Update all the files that are required to go into the root folder or live version
if [ $tag == $tag_default ]
then
Expand Down
3 changes: 0 additions & 3 deletions docs/error/404.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/error/api.md

This file was deleted.

14 changes: 14 additions & 0 deletions docs/mxdoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# under the License.

"""A sphnix-doc plugin to build mxnet docs"""
from __future__ import print_function
import subprocess
import re
import os
Expand Down Expand Up @@ -434,6 +435,18 @@ def add_buttons(app, docname, source):

# source[i] = '\n'.join(lines)


def copy_artifacts(app):
"""Copies artifacts needed for website presentation"""
print("Copying artifacts...")
dest_path = app.builder.outdir + '/error/'
_run_cmd('cd ' + app.builder.srcdir)
_run_cmd('cp build_version_doc/artifacts/404.html ' + dest_path)
_run_cmd('cp build_version_doc/artifacts/api.html ' + dest_path)
dest_path = app.builder.outdir + '/_static/'
_run_cmd('cp _static/mxnet.css ' + dest_path)


def setup(app):
# If MXNET_DOCS_BUILD_MXNET is set something different than 1
# Skip the build step
Expand All @@ -458,6 +471,7 @@ def setup(app):
if _R_DOCS:
print("Building R Docs!")
app.connect("builder-inited", build_r_docs)
app.connect("builder-inited", copy_artifacts)
app.connect('source-read', convert_table)
app.connect('source-read', add_buttons)
app.add_config_value('recommonmark_config', {
Expand Down

0 comments on commit 0b00237

Please sign in to comment.