Skip to content

Commit bed3464

Browse files
committed
Disable offline docs
They take too much space as-is. We should probably just offer a docs download instead.
1 parent 83a100f commit bed3464

4 files changed

Lines changed: 21 additions & 15 deletions

File tree

docs

Submodule docs updated 113 files

src/app/CMakeLists.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,7 @@ endif()
411411

412412
if(UNIX AND NOT APPLE)
413413
option(INSTALL_DOCS "Install documentation on Linux/BSD" ON)
414+
#option(INSTALL_OFFLINE_DOCS "Install offline documentation on Linux/BSD" OFF)
414415
target_link_libraries(
415416
${PROJECT_NAME}
416417
PRIVATE
@@ -487,11 +488,13 @@ if(UNIX AND NOT APPLE)
487488
DESTINATION
488489
${CMAKE_INSTALL_DOCDIR}
489490
)
490-
install(
491-
DIRECTORY
492-
${CMAKE_CURRENT_SOURCE_DIR}/../../docs/offline/
493-
DESTINATION
494-
${CMAKE_INSTALL_DOCDIR}/html
495-
)
491+
#if(${INSTALL_OFFLINE_DOCS})
492+
# install(
493+
# DIRECTORY
494+
# ${CMAKE_CURRENT_SOURCE_DIR}/../../docs/offline/
495+
# DESTINATION
496+
# ${CMAKE_INSTALL_DOCDIR}/html
497+
# )
498+
#endif()
496499
endif()
497500
endif()

src/core/appsupport.cpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,7 +1131,7 @@ void AppSupport::setFont(const QString &path)
11311131

11321132
QString AppSupport::getOfflineDocs()
11331133
{
1134-
#ifdef Q_OS_LINUX
1134+
/*#ifdef Q_OS_LINUX
11351135
if (isFlatpak()) {
11361136
// we can't have offline docs in a flatpak
11371137
return QString();
@@ -1143,7 +1143,8 @@ QString AppSupport::getOfflineDocs()
11431143
for (const auto &path : paths) {
11441144
qDebug() << "Checking for docs ..." << path;
11451145
if (QFile::exists(path)) { return path; }
1146-
}
1146+
}*/
1147+
// offline docs are currently disabled
11471148
return QString();
11481149
}
11491150

src/scripts/build_mac.sh

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,19 @@ macdeployqt src/app/Friction.app
8484
rm -f src/app/Friction.app/Contents/Frameworks/{libQt5MultimediaWidgets.5.dylib,libQt5Svg.5.dylib}
8585
rm -rf src/app/Friction.app/Contents/PlugIns/{bearer,iconengines,imageformats,mediaservice,printsupport,styles}
8686

87-
if [ -f "${CWD}/docs/offline/index.html" ]; then
88-
cp -a ${CWD}/docs/offline src/app/Friction.app/Contents/Resources/docs
89-
fi
87+
# disable offline docs for now
88+
#if [ -f "${CWD}/docs/offline/index.html" ]; then
89+
# cp -a ${CWD}/docs/offline src/app/Friction.app/Contents/Resources/docs
90+
#fi
9091

9192
mkdir dmg
9293
mv src/app/Friction.app dmg/
9394
(cd dmg ; ln -sf /Applications Applications)
9495

95-
if [ -f "${CWD}/docs/offline/index.html" ]; then
96-
(cd dmg ; ln -sf Friction.app/Contents/Resources/docs/index.html Documentation.html)
97-
fi
96+
# disable offline docs for now
97+
#if [ -f "${CWD}/docs/offline/index.html" ]; then
98+
# (cd dmg ; ln -sf Friction.app/Contents/Resources/docs/index.html Documentation.html)
99+
#fi
98100

99101
# https://github.com/actions/runner-images/issues/7522
100102
max_tries=10

0 commit comments

Comments
 (0)