From d5fcf19814a7ddba0f32f5b09a5b28245cc993a2 Mon Sep 17 00:00:00 2001 From: Varun Patil Date: Sun, 22 Oct 2023 13:19:23 -0700 Subject: [PATCH] docs: fix config defaults Signed-off-by: Varun Patil --- .github/workflows/docs.yaml | 12 +++++++++--- docs/.gitignore | 3 ++- docs/system-config.md | 4 +++- lib/Settings/SystemConfig.php | 7 ++++--- 4 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 4399d727..49fb24b0 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -16,13 +16,19 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 with: python-version: 3.x + - uses: actions/cache@v2 with: key: ${{ github.ref }} path: .cache - - run: cp CHANGELOG.md docs/changelog.md - - run: pip install mkdocs-material pillow cairosvg - - run: mkdocs gh-deploy --force + + - name: Build documentation + run: | + cp CHANGELOG.md docs/changelog.md + sed -n '/DEFAULTS = \[/,/];/p' lib/Settings/SystemConfig.php | sed 's/^ //' > docs/system-config.php + pip install mkdocs-material pillow cairosvg + mkdocs gh-deploy --force diff --git a/docs/.gitignore b/docs/.gitignore index d2830b68..5e29943f 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1 +1,2 @@ -changelog.md \ No newline at end of file +changelog.md +system-config.php \ No newline at end of file diff --git a/docs/system-config.md b/docs/system-config.md index ec9e45d0..ff28f8e6 100644 --- a/docs/system-config.md +++ b/docs/system-config.md @@ -7,5 +7,7 @@ description: Documentation for config.php options that Memories uses This is a list of all options in `config.php` that memories uses ```php ---8<-- "lib/SystemConfigDefault.php" + '', @@ -18,7 +20,7 @@ class SystemConfig // Temporary directory for non-php binaries. The directory must be writable // and the webserver user should be able to create executable binaries in it. - // Note that go-vod temp files are separately configured (see memories.vod.tempdir) + // go-vod temp files are separately configured (memories.vod.tempdir) // Defaults to system temp directory if blank 'memories.exiftool.tmp' => '', @@ -36,7 +38,7 @@ class SystemConfig 'memories.gis_type' => -1, // Default timeline path for all users - // If set to '_empty_', the user is prompted to select a path on first open (default) + // If set to '_empty_', the user is prompted to select a path 'memories.timeline.default_path' => '_empty_', // Default viewer high resolution image loading condition @@ -89,7 +91,6 @@ class SystemConfig 'memories.video_default_quality' => '0', // Memories only provides an admin interface for these - // https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#previews 'enabledPreviewProviders' => [], 'preview_max_x' => 4096, 'preview_max_y' => 4096,