mirror of
https://github.com/flutter/flutter
synced 2024-09-13 05:11:45 +00:00
Add docset generation (#24322)
(re-land of #24244) This generates a zip file containing all of the docs, and uploads it when we publish docs, as well as a Dash/Zeal docset that contains a feed of the docs. Addresses at least part of #9955
This commit is contained in:
parent
f9bccb0280
commit
f20adcc428
|
@ -30,6 +30,44 @@ function script_location() {
|
|||
echo "$(cd -P "$(dirname "$script_location")" >/dev/null && pwd)"
|
||||
}
|
||||
|
||||
# Zip up the docs so people can download them for offline usage.
|
||||
function create_offline_zip() {
|
||||
# Must be run from "$FLUTTER_ROOT/dev/docs"
|
||||
echo "Zipping Flutter offline docs archive."
|
||||
rm -rf flutter.docs.zip doc/offline
|
||||
(cd ./doc; zip -r -9 -q ../flutter.docs.zip .)
|
||||
}
|
||||
|
||||
# Generate the docset for Flutter docs for use with Dash, Zeal, and Velocity.
|
||||
function create_docset() {
|
||||
# Must be run from "$FLUTTER_ROOT/dev/docs"
|
||||
# Must have dashing installed: go get -u github.com/technosophos/dashing
|
||||
# Dashing produces a LOT of output (~30MB), so we redirect it, and just show
|
||||
# the end of it if there was a problem.
|
||||
echo "Building Flutter docset."
|
||||
rm -rf flutter.docset
|
||||
(dashing build --source ./doc --config ./dashing.json > /tmp/dashing.log 2>&1 || (tail -100 /tmp/dashing.log; false)) && \
|
||||
tar cf flutter.docset.tar.gz --use-compress-program="gzip --best" flutter.docset
|
||||
}
|
||||
|
||||
# Move the offline archives into place, after all the processing of the doc
|
||||
# directory is done. This avoids the tools recursively processing the archives
|
||||
# as part of their process.
|
||||
function move_offline_into_place() {
|
||||
# Must be run from "$FLUTTER_ROOT/dev/docs"
|
||||
echo "Moving offline data into place."
|
||||
mkdir -p doc/offline
|
||||
mv flutter.docs.zip doc/offline/flutter.docs.zip
|
||||
du -sh doc/offline/flutter.docs.zip
|
||||
if [[ "$CIRRUS_BRANCH" == "stable" ]]; then
|
||||
echo -e "<entry>\n <version>${FLUTTER_VERSION}</version>\n <url>https://docs.flutter.io/offline/flutter.docset.tar.gz</url>\n</entry>" > doc/offline/flutter.xml
|
||||
else
|
||||
echo -e "<entry>\n <version>${FLUTTER_VERSION}</version>\n <url>https://master-docs-flutter-io.firebaseapp.com/offline/flutter.docset.tar.gz</url>\n</entry>" > doc/offline/flutter.xml
|
||||
fi
|
||||
mv flutter.docset.tar.gz doc/offline/flutter.docset.tar.gz
|
||||
du -sh doc/offline/flutter.docset.tar.gz
|
||||
}
|
||||
|
||||
# So that users can run this script from anywhere and it will work as expected.
|
||||
SCRIPT_LOCATION="$(script_location)"
|
||||
# Sets the Flutter root to be "$(script_location)/../..": This script assumes
|
||||
|
@ -53,12 +91,13 @@ export PATH="$FLUTTER_BIN:$DART_BIN:$PATH"
|
|||
|
||||
# Make sure dart is installed by invoking flutter to download it.
|
||||
"$FLUTTER" --version
|
||||
FLUTTER_VERSION=$(cat "$FLUTTER_ROOT/version")
|
||||
|
||||
# If the pub cache directory exists in the root, then use that.
|
||||
FLUTTER_PUB_CACHE="$FLUTTER_ROOT/.pub-cache"
|
||||
if [[ -d "$FLUTTER_PUB_CACHE" ]]; then
|
||||
# This has to be exported, because pub interprets setting it
|
||||
# to the empty string in the same way as setting it to ".".
|
||||
# This has to be exported, because pub interprets setting it to the empty
|
||||
# string in the same way as setting it to ".".
|
||||
export PUB_CACHE="${PUB_CACHE:-"$FLUTTER_PUB_CACHE"}"
|
||||
fi
|
||||
|
||||
|
@ -72,6 +111,11 @@ fi
|
|||
(cd "$FLUTTER_ROOT" && "$DART" "$FLUTTER_ROOT/dev/tools/dartdoc.dart")
|
||||
(cd "$FLUTTER_ROOT" && "$DART" "$FLUTTER_ROOT/dev/tools/java_and_objc_doc.dart")
|
||||
|
||||
# Create offline doc archives.
|
||||
(cd "$FLUTTER_ROOT/dev/docs"; create_offline_zip)
|
||||
(cd "$FLUTTER_ROOT/dev/docs"; create_docset)
|
||||
(cd "$FLUTTER_ROOT/dev/docs"; move_offline_into_place)
|
||||
|
||||
# Ensure google webmaster tools can verify our site.
|
||||
cp "$FLUTTER_ROOT/dev/docs/google2ed1af765c529f57.html" "$FLUTTER_ROOT/dev/docs/doc"
|
||||
|
||||
|
|
|
@ -21,6 +21,7 @@ RUN apt-get install -y --no-install-recommends \
|
|||
git \
|
||||
wget \
|
||||
curl \
|
||||
zip \
|
||||
unzip \
|
||||
ca-certificates \
|
||||
gnupg
|
||||
|
@ -34,6 +35,7 @@ RUN bash "${NODEJS_INSTALL}/nodejs_install.sh"
|
|||
# Install the rest of the dependencies.
|
||||
RUN apt-get install -y --no-install-recommends \
|
||||
locales \
|
||||
golang \
|
||||
ruby \
|
||||
ruby-dev \
|
||||
nodejs \
|
||||
|
@ -82,13 +84,22 @@ ENV PATH="$GRADLE_ROOT/bin:$PATH"
|
|||
ENV PATH="/usr/bin:${PATH}"
|
||||
RUN dpkg-query -L nodejs
|
||||
# Install Firebase
|
||||
RUN /usr/bin/npm install -g git://github.com/firebase/firebase-tools.git
|
||||
# This is why we need nodejs installed.
|
||||
RUN /usr/bin/npm --verbose install -g firebase-tools
|
||||
|
||||
# Install dashing
|
||||
# This is why we need golang installed.
|
||||
RUN mkdir -p /opt/gopath/bin
|
||||
ENV GOPATH=/opt/gopath
|
||||
ENV PATH="${GOPATH}/bin:${PATH}"
|
||||
RUN go get -u github.com/technosophos/dashing
|
||||
|
||||
# Set locale to en_US
|
||||
RUN locale-gen en_US "en_US.UTF-8" && dpkg-reconfigure locales
|
||||
ENV LANG en_US.UTF-8
|
||||
|
||||
# Install coveralls and Firebase
|
||||
# This is why we need ruby installed.
|
||||
RUN gem install coveralls
|
||||
RUN gem install bundler
|
||||
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
{
|
||||
"name": "flutter",
|
||||
"package": "flutter",
|
||||
"version": "{{VERSION}}",
|
||||
"author": {
|
||||
"name": "The Flutter Team",
|
||||
"link": "https://flutter.io"
|
||||
|
@ -102,4 +101,4 @@
|
|||
"ignore": [
|
||||
"ABOUT"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue