diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 859109cd..b6a01f74 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -3,7 +3,7 @@ name: CI on: pull_request: - branches: [master, nightly] + branches: [master] types: [opened, synchronize, reopened] push: branches: [master] @@ -14,28 +14,39 @@ concurrency: cancel-in-progress: true jobs: - check_changelog: - name: Check Changelog + setup_release: + name: Setup Release + outputs: + changelog_changes: ${{ steps.setup_release.outputs.changelog_changes }} + changelog_date: ${{ steps.setup_release.outputs.changelog_date }} + changelog_exists: ${{ steps.setup_release.outputs.changelog_exists }} + changelog_release_exists: ${{ steps.setup_release.outputs.changelog_release_exists }} + changelog_url: ${{ steps.setup_release.outputs.changelog_url }} + changelog_version: ${{ steps.setup_release.outputs.changelog_version }} + publish_pre_release: ${{ steps.setup_release.outputs.publish_pre_release }} + publish_release: ${{ steps.setup_release.outputs.publish_release }} + publish_stable_release: ${{ steps.setup_release.outputs.publish_stable_release }} + release_body: ${{ steps.setup_release.outputs.release_body }} + release_build: ${{ steps.setup_release.outputs.release_build }} + release_commit: ${{ steps.setup_release.outputs.release_commit }} + release_generate_release_notes: ${{ steps.setup_release.outputs.release_generate_release_notes }} + release_tag: ${{ steps.setup_release.outputs.release_tag }} + release_version: ${{ steps.setup_release.outputs.release_version }} runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 - - name: Verify Changelog - id: verify_changelog - if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }} - # base_ref for pull request check, ref for push - uses: LizardByte/.github/actions/verify_changelog@master + - name: Setup Release + id: setup_release + uses: LizardByte/setup-release-action@v2023.1128.1400 with: - token: ${{ secrets.GITHUB_TOKEN }} - outputs: - next_version: ${{ steps.verify_changelog.outputs.changelog_parser_version }} - last_version: ${{ steps.verify_changelog.outputs.latest_release_tag_name }} - release_body: ${{ steps.verify_changelog.outputs.changelog_parser_description }} + github_token: ${{ secrets.GITHUB_TOKEN }} build: + needs: + - setup_release runs-on: ubuntu-20.04 - needs: check_changelog steps: - name: Checkout @@ -80,7 +91,7 @@ jobs: shell: bash working-directory: Themerr-plex.bundle env: - BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version }} + BUILD_VERSION: ${{ needs.setup_release.outputs.release_tag }} run: | python ./scripts/build_plist.py @@ -115,14 +126,18 @@ jobs: path: | ${{ github.workspace }}/artifacts - - name: Create Release - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} - uses: LizardByte/.github/actions/create_release@master + - name: Create/Update GitHub Release + if: ${{ needs.setup_release.outputs.publish_release == 'true' }} + uses: LizardByte/create-release-action@v2023.1128.2625 with: + allowUpdates: true + body: '' + discussionCategory: announcements + generateReleaseNotes: true + name: ${{ needs.setup_release.outputs.release_tag }} + prerelease: ${{ needs.setup_release.outputs.publish_pre_release }} + tag: ${{ needs.setup_release.outputs.release_tag }} token: ${{ secrets.GH_BOT_TOKEN }} - next_version: ${{ needs.check_changelog.outputs.next_version }} - last_version: ${{ needs.check_changelog.outputs.last_version }} - release_body: ${{ needs.check_changelog.outputs.release_body }} pytest: needs: [build] diff --git a/.github/workflows/ci-docker.yml b/.github/workflows/ci-docker.yml index edeeb2bd..7e87726e 100644 --- a/.github/workflows/ci-docker.yml +++ b/.github/workflows/ci-docker.yml @@ -78,78 +78,37 @@ jobs: dockerfiles: ${{ steps.find.outputs.dockerfiles }} matrix: ${{ steps.find.outputs.matrix }} - check_changelog: - name: Check Changelog - needs: [check_dockerfiles] + setup_release: if: ${{ needs.check_dockerfiles.outputs.dockerfiles }} + name: Setup Release + needs: + - check_dockerfiles + outputs: + changelog_changes: ${{ steps.setup_release.outputs.changelog_changes }} + changelog_date: ${{ steps.setup_release.outputs.changelog_date }} + changelog_exists: ${{ steps.setup_release.outputs.changelog_exists }} + changelog_release_exists: ${{ steps.setup_release.outputs.changelog_release_exists }} + changelog_url: ${{ steps.setup_release.outputs.changelog_url }} + changelog_version: ${{ steps.setup_release.outputs.changelog_version }} + publish_pre_release: ${{ steps.setup_release.outputs.publish_pre_release }} + publish_release: ${{ steps.setup_release.outputs.publish_release }} + publish_stable_release: ${{ steps.setup_release.outputs.publish_stable_release }} + release_body: ${{ steps.setup_release.outputs.release_body }} + release_build: ${{ steps.setup_release.outputs.release_build }} + release_commit: ${{ steps.setup_release.outputs.release_commit }} + release_generate_release_notes: ${{ steps.setup_release.outputs.release_generate_release_notes }} + release_tag: ${{ steps.setup_release.outputs.release_tag }} + release_version: ${{ steps.setup_release.outputs.release_version }} runs-on: ubuntu-latest steps: - name: Checkout - if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }} uses: actions/checkout@v4 - - name: Verify Changelog - id: verify_changelog - if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' }} - # base_ref for pull request check, ref for push - uses: LizardByte/.github/actions/verify_changelog@master + - name: Setup Release + id: setup_release + uses: LizardByte/setup-release-action@v2023.1128.1400 with: - token: ${{ secrets.GITHUB_TOKEN }} - outputs: - next_version: ${{ steps.verify_changelog.outputs.changelog_parser_version }} - next_version_bare: ${{ steps.verify_changelog.outputs.changelog_parser_version_bare }} - last_version: ${{ steps.verify_changelog.outputs.latest_release_tag_name }} - release_body: ${{ steps.verify_changelog.outputs.changelog_parser_description }} - - setup_release: - name: Setup Release - needs: check_changelog - runs-on: ubuntu-latest - steps: - - name: Set release details - id: release_details - env: - RELEASE_BODY: ${{ needs.check_changelog.outputs.release_body }} - run: | - # determine to create a release or not - if [[ $GITHUB_EVENT_NAME == "push" ]]; then - RELEASE=true - else - RELEASE=false - fi - - # set the release tag - COMMIT=${{ github.sha }} - if [[ $GITHUB_REF == refs/heads/master ]]; then - TAG="${{ needs.check_changelog.outputs.next_version }}" - RELEASE_NAME="${{ needs.check_changelog.outputs.next_version }}" - RELEASE_BODY="$RELEASE_BODY" - PRE_RELEASE="false" - elif [[ $GITHUB_REF == refs/heads/nightly ]]; then - TAG="nightly-dev" - RELEASE_NAME="nightly" - RELEASE_BODY="automated nightly release - $(date -u +'%Y-%m-%dT%H:%M:%SZ') - ${COMMIT}" - PRE_RELEASE="true" - fi - - echo "create_release=${RELEASE}" >> $GITHUB_OUTPUT - echo "release_tag=${TAG}" >> $GITHUB_OUTPUT - echo "release_commit=${COMMIT}" >> $GITHUB_OUTPUT - echo "release_name=${RELEASE_NAME}" >> $GITHUB_OUTPUT - echo "pre_release=${PRE_RELEASE}" >> $GITHUB_OUTPUT - - # this is stupid but works for multiline strings - echo "RELEASE_BODY<> $GITHUB_ENV - echo "$RELEASE_BODY" >> $GITHUB_ENV - echo "EOF" >> $GITHUB_ENV - - outputs: - create_release: ${{ steps.release_details.outputs.create_release }} - release_tag: ${{ steps.release_details.outputs.release_tag }} - release_commit: ${{ steps.release_details.outputs.release_commit }} - release_name: ${{ steps.release_details.outputs.release_name }} - release_body: ${{ env.RELEASE_BODY }} - pre_release: ${{ steps.release_details.outputs.pre_release }} + github_token: ${{ secrets.GITHUB_TOKEN }} lint_dockerfile: needs: [check_dockerfiles] @@ -180,7 +139,7 @@ jobs: cat "./hadolint.log" >> $GITHUB_STEP_SUMMARY docker: - needs: [check_dockerfiles, check_changelog, setup_release] + needs: [check_dockerfiles, setup_release] if: ${{ needs.check_dockerfiles.outputs.dockerfiles }} runs-on: ubuntu-latest permissions: @@ -210,24 +169,20 @@ jobs: - name: Prepare id: prepare env: - NV: ${{ needs.check_changelog.outputs.next_version }} + NV: ${{ needs.setup_release.outputs.release_tag }} run: | # get branch name BRANCH=${GITHUB_HEAD_REF} - RELEASE=false + RELEASE=${{ needs.setup_release.outputs.publish_release }} + COMMIT=${{ needs.setup_release.outputs.release_commit }} if [ -z "$BRANCH" ]; then echo "This is a PUSH event" BRANCH=${{ github.ref_name }} - COMMIT=${{ github.sha }} CLONE_URL=${{ github.event.repository.clone_url }} - if [[ $BRANCH == "master" ]]; then - RELEASE=true - fi else echo "This is a PULL REQUEST event" - COMMIT=${{ github.event.pull_request.head.sha }} CLONE_URL=${{ github.event.pull_request.head.repo.clone_url }} fi @@ -260,7 +215,7 @@ jobs: # parse custom directives out of dockerfile # try to get the platforms from the dockerfile custom directive, i.e. `# platforms: xxx,yyy` # directives for PR event, i.e. not push event - if [[ ${PUSH} == "false" ]]; then + if [[ ${RELEASE} == "false" ]]; then while read -r line; do if [[ $line == "# platforms_pr: "* && $PLATFORMS == "" ]]; then # echo the line and use `sed` to remove the custom directive @@ -299,13 +254,10 @@ jobs: echo "branch=${BRANCH}" >> $GITHUB_OUTPUT echo "build_date=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_OUTPUT - echo "commit=${COMMIT}" >> $GITHUB_OUTPUT echo "clone_url=${CLONE_URL}" >> $GITHUB_OUTPUT - echo "release=${RELEASE}" >> $GITHUB_OUTPUT echo "artifacts=${ARTIFACTS}" >> $GITHUB_OUTPUT echo "no_cache_filters=${NO_CACHE_FILTERS}" >> $GITHUB_OUTPUT echo "platforms=${PLATFORMS}" >> $GITHUB_OUTPUT - echo "push=${PUSH}" >> $GITHUB_OUTPUT echo "tags=${TAGS}" >> $GITHUB_OUTPUT - name: Set Up QEMU @@ -324,14 +276,14 @@ jobs: Docker-buildx${{ matrix.tag }}- - name: Log in to Docker Hub - if: ${{ steps.prepare.outputs.push == 'true' }} # PRs do not have access to secrets + if: ${{ needs.setup_release.outputs.publish_release == 'true' }} # PRs do not have access to secrets uses: docker/login-action@v3 with: username: ${{ secrets.DOCKER_HUB_USERNAME }} password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }} - name: Log in to the Container registry - if: ${{ steps.prepare.outputs.push == 'true' }} # PRs do not have access to secrets + if: ${{ needs.setup_release.outputs.publish_release == 'true' }} # PRs do not have access to secrets uses: docker/login-action@v3 with: registry: ghcr.io @@ -352,10 +304,10 @@ jobs: build-args: | BRANCH=${{ steps.prepare.outputs.branch }} BUILD_DATE=${{ steps.prepare.outputs.build_date }} - BUILD_VERSION=${{ needs.check_changelog.outputs.next_version }} - COMMIT=${{ steps.prepare.outputs.commit }} + BUILD_VERSION=${{ needs.setup_release.outputs.release_tag }} + COMMIT=${{ needs.setup_release.outputs.release_commit }} CLONE_URL=${{ steps.prepare.outputs.clone_url }} - RELEASE=${{ steps.prepare.outputs.release }} + RELEASE=${{ needs.setup_release.outputs.publish_release }} tags: ${{ steps.prepare.outputs.tags }} cache-from: type=local,src=/tmp/.buildx-cache cache-to: type=local,dest=/tmp/.buildx-cache @@ -367,15 +319,15 @@ jobs: with: context: ./ file: ${{ matrix.dockerfile }} - push: ${{ steps.prepare.outputs.push }} + push: ${{ needs.setup_release.outputs.publish_release }} platforms: ${{ steps.prepare.outputs.platforms }} build-args: | BRANCH=${{ steps.prepare.outputs.branch }} BUILD_DATE=${{ steps.prepare.outputs.build_date }} - BUILD_VERSION=${{ needs.check_changelog.outputs.next_version }} - COMMIT=${{ steps.prepare.outputs.commit }} + BUILD_VERSION=${{ needs.setup_release.outputs.release_tag }} + COMMIT=${{ needs.setup_release.outputs.release_commit }} CLONE_URL=${{ steps.prepare.outputs.clone_url }} - RELEASE=${{ steps.prepare.outputs.release }} + RELEASE=${{ needs.setup_release.outputs.publish_release }} tags: ${{ steps.prepare.outputs.tags }} cache-from: type=local,src=/tmp/.buildx-cache cache-to: type=local,dest=/tmp/.buildx-cache @@ -401,18 +353,18 @@ jobs: path: artifacts/ - name: Create/Update GitHub Release - if: ${{ needs.setup_release.outputs.create_release == 'true' && steps.prepare.outputs.artifacts == 'true' }} - uses: ncipollo/release-action@v1 + if: ${{ needs.setup_release.outputs.publish_release == 'true' && steps.prepare.outputs.artifacts == 'true' }} + uses: LizardByte/create-release-action@v2023.1128.2625 with: - name: ${{ needs.setup_release.outputs.release_name }} - tag: ${{ needs.setup_release.outputs.release_tag }} - commit: ${{ needs.setup_release.outputs.release_commit }} - artifacts: "*artifacts/*" - token: ${{ secrets.GH_BOT_TOKEN }} allowUpdates: true - body: ${{ needs.setup_release.outputs.release_body }} + artifacts: "*artifacts/*" + body: '' discussionCategory: announcements - prerelease: ${{ needs.setup_release.outputs.pre_release }} + generateReleaseNotes: true + name: ${{ needs.setup_release.outputs.release_tag }} + prerelease: ${{ needs.setup_release.outputs.publish_pre_release }} + tag: ${{ needs.setup_release.outputs.release_tag }} + token: ${{ secrets.GH_BOT_TOKEN }} - name: Update Docker Hub Description if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} diff --git a/.github/workflows/localize.yml b/.github/workflows/localize.yml index c977f3b1..e65053b4 100644 --- a/.github/workflows/localize.yml +++ b/.github/workflows/localize.yml @@ -3,7 +3,7 @@ name: localize on: push: - branches: [nightly] + branches: [master] paths: # prevents workflow from running unless these files change - '.github/workflows/localize.yml' - 'Contents/Strings/Themerr-plex.po' @@ -21,7 +21,7 @@ jobs: uses: actions/checkout@v4 - name: Set up Python - uses: LizardByte/action-setup-python@master + uses: LizardByte/setup-python-action@v2023.1128.10441 with: python-version: '2.7' @@ -64,7 +64,7 @@ jobs: commit-message: New localization template branch: localize/update delete-branch: true - base: nightly + base: master title: New Babel Updates body: | Update report diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index be07eca4..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,159 +0,0 @@ -# Changelog - -## [0.3.1] - 2023-12-02 -Attention, if you used Themerr-plex prior to v0.3.0, the themes added there will be in a locked state. To allow -Themerr-plex the ability to update these themes in the future, you must unlock them. We have provided a new config -option that will allow you to automatically unlock all themes for libraries supported by Themerr-plex. - -**Added** -- Add option to migrate from versions < v0.3.0 - -**Fixed** -- Fixed random _strptime import errors - -**Dependencies** -- Bump plexhints from 0.1.3 to 2023.1201.11810 -- Bump @fortawesome/fontawesome-free from 6.5.0 to 6.5.1 - -**Misc** -- Refactor plex server creation -- Parametrize movie library fixtures in unit tests - -## [0.3.0] - 2023-11-29 -**Added** -- Option to enable/disable support for Plex Movie agent - (enabled by default) -- Option to update themes on a schedule - (enabled by default) -- Option to download themes for collections - (enabled by default) -- Option to update collection metadata (art, poster, and summary) - - (enabled by default for legacy agents, disabled for Plex Movie agent) -- Options to remove unused media (themes, art, posters) on update - - (enabled by default for themes, disabled for art and posters) -- Themerr icon -- Version is now printed to the log on startup -- Version is now displayed in the Plex plugin menu -- Web UI which shows the completion percentage of theme songs in the Plex libraries -- Option to add YouTube cookies to workaround EU consent issue - -**Fixed** -- Themerr-plex will now skip upload of media if the existing media is the same -- Themerr-plex is now categorized as a Utility plugin instead of Music -- Refactored code to use common methods where possible -- Use TMDB api to convert IMDB ids to TMDB ids -- Fix AlertListener on IPv6-aware hosts -- Fix error handling around update_plex_item to prevent plugin hanging -- youtube-dl messages are now logged to Themerr-plex plugin log -- Disable plexapi auto-reload -- Use correct types for plex item typehints -- Ensure themes added by Themerr-plex are unlocked -- Don't update metadata/fields which are locked -- Disable restricted python in Plex plugin framework -- Remove unused YouTube parameters - -**Dependencies** -- Bump peter-evans/create-pull-request from 4 to 5 -- Bump actions/checkout from 3 to 4 -- Use plexapi-backport and bump to 4.15.6 -- Use plexhints from pypi and bump to 0.1.3 -- Bump youtube-dl to 00ef748 - -**Misc** -- Update LizardByte workflows -- Improve CI/CD testing -- Add CodeQL analysis - -## [0.2.0] - 2023-07-31 -**Added** -- Add option to prefer MPEG AAC audio codec over Opus - -**Fixed** -- Fix issue where most theme songs would not play on Apple devices. -- Remove tests directory from release package - -## [0.1.4] - 2023-04-20 -**Fixed** -- Updated youtube_dl, fixing an issue where plugin would fail to get themes in some cases - -**Misc** -- LinuxServer.io images now support mods with multi-digest layers (https://github.com/linuxserver/docker-mods/pull/577) - -## [0.1.3] - 2023-01-28 -**Added** -- Max Retries setting added, allowing you to specify how many times to retry a failed upload - -**Fixed** -- Improve error handling and logging when theme song does not exist in ThemerrDB - -## [0.1.2] - 2023-01-23 -**Added** -- Process items from Plex Movie agent with a queue -- Allow specifying number of simultaneous items to process for Plex Movie agent - -**Fixed** -- Fixed issue where plugin would be unresponsive to changes from Plex Movie agent after 30 minutes - -## [0.1.1] - 2023-01-19 -**Fixed** -- Fixed `plexapi.utils` import, causing plugin to hang - -## [0.1.0] - 2023-01-18 -**Added** -- Added support for new Plex Movie agent - -## [0.0.8] - 2023-01-02 -**Fixed** -- Fixed Read the Docs build error for epub - -## [0.0.7] - 2022-12-28 -**Fixed** -- Fixed readme status badge - -## [0.0.6] - 2022-12-28 -**Changed** -- Plex token is now automatically fetched from the Plex python environment - -## [0.0.5] - 2022-10-15 -**Fixed** -- changing timeout no longer requires a Plex Media Server restart - -## [0.0.4] - 2022-10-14 -**Fixed** -- issue with timeout not being respected -- agent info formatting corrected -- documentation corrected, it is not required to re-match movies/items - -**Changed** -- default timeout is now 180 seconds - -## [0.0.3] - 2022-10-09 -**Fixed** -- use try/except/else for plexhints import -- docker build was missing some plugin files -- dockerignore file was not being respected -- issue with special characters being replaced in plist file - -**Changed** -- move plugin to `Music` category - -## [0.0.2] - 2022-10-04 -**Fixed** -- `plexhints` import error on Docker -- Reduced release bundle size - -## [0.0.1] - 2022-10-03 -**Added** -- Initial Release - -[0.0.1]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.1 -[0.0.2]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.2 -[0.0.3]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.3 -[0.0.4]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.4 -[0.0.5]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.5 -[0.0.6]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.6 -[0.0.7]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.7 -[0.0.8]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.0.8 -[0.1.0]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.1.0 -[0.1.1]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.1.1 -[0.1.2]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.1.2 -[0.1.3]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.1.3 -[0.1.4]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.1.4 -[0.2.0]: https://github.com/lizardbyte/themerr-plex/releases/tag/v0.2.0 diff --git a/README.rst b/README.rst index 339a8b28..1841c523 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/README.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/README.rst Overview ======== diff --git a/docs/source/about/changelog.rst b/docs/source/about/changelog.rst index 7aadfa7e..1787332f 100644 --- a/docs/source/about/changelog.rst +++ b/docs/source/about/changelog.rst @@ -1 +1,17 @@ -.. mdinclude:: ../../../CHANGELOG.md +Changelog +========= + +.. only:: epub + + You can view the changelog in the + `online version `__. + +.. only:: html + + .. raw:: html + + + + diff --git a/docs/source/about/docker.rst b/docs/source/about/docker.rst index 1c0682d8..e2bd3179 100644 --- a/docs/source/about/docker.rst +++ b/docs/source/about/docker.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/DOCKER_README.md +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/DOCKER_README.md Docker ------ diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index 24ceb628..2535e766 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/about/installation.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/about/installation.rst Installation ============ diff --git a/docs/source/about/troubleshooting.rst b/docs/source/about/troubleshooting.rst index baceb0a4..78da34dc 100644 --- a/docs/source/about/troubleshooting.rst +++ b/docs/source/about/troubleshooting.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/about/troubleshooting.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/about/troubleshooting.rst Troubleshooting =============== @@ -13,7 +13,7 @@ Adding your YouTube credentials (e-mail and password) in Themerr's preference ma YouTube also sometimes changes the way its login page works, preventing YouTube-DL from using those credentials. A workaround is to login in a web browser, and then export your YouTube cookies with a tool such as `Get cookies.txt -locally `__. Note +locally `__. Note that Themerr currently only supports Chromium's JSON export format. In the exporter you use, if prompted, you need to use the "JSON" or "Chrome" format. diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst index b15caac9..13929b14 100644 --- a/docs/source/about/usage.rst +++ b/docs/source/about/usage.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/about/usage.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/about/usage.rst Usage ===== diff --git a/docs/source/code_docs/general_helper.rst b/docs/source/code_docs/general_helper.rst index 182e872a..7143af31 100644 --- a/docs/source/code_docs/general_helper.rst +++ b/docs/source/code_docs/general_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/general_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/general_helper.py .. include:: ../global.rst diff --git a/docs/source/code_docs/lizardbyte_db_helper.rst b/docs/source/code_docs/lizardbyte_db_helper.rst index c2a9bc2e..8fcf8e3f 100644 --- a/docs/source/code_docs/lizardbyte_db_helper.rst +++ b/docs/source/code_docs/lizardbyte_db_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/lizardbyte_db_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/lizardbyte_db_helper.py .. include:: ../global.rst diff --git a/docs/source/code_docs/main.rst b/docs/source/code_docs/main.rst index 72724119..5c8a4212 100644 --- a/docs/source/code_docs/main.rst +++ b/docs/source/code_docs/main.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/__init__.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/__init__.py .. include:: ../global.rst diff --git a/docs/source/code_docs/migration_helper.rst b/docs/source/code_docs/migration_helper.rst index b5d2f699..9f8b7eb1 100644 --- a/docs/source/code_docs/migration_helper.rst +++ b/docs/source/code_docs/migration_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/migration_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/migration_helper.py .. include:: ../global.rst diff --git a/docs/source/code_docs/plex_api_helper.rst b/docs/source/code_docs/plex_api_helper.rst index 870cddca..76acff11 100644 --- a/docs/source/code_docs/plex_api_helper.rst +++ b/docs/source/code_docs/plex_api_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/plex_api_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/plex_api_helper.py .. include:: ../global.rst diff --git a/docs/source/code_docs/scheduled_tasks.rst b/docs/source/code_docs/scheduled_tasks.rst index 1dca784b..edfa4ccb 100644 --- a/docs/source/code_docs/scheduled_tasks.rst +++ b/docs/source/code_docs/scheduled_tasks.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/scheduled_tasks.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/scheduled_tasks.py .. include:: ../global.rst diff --git a/docs/source/code_docs/tmdb_helper.rst b/docs/source/code_docs/tmdb_helper.rst index 195ecec1..4d73092b 100644 --- a/docs/source/code_docs/tmdb_helper.rst +++ b/docs/source/code_docs/tmdb_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/tmdb_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/tmdb_helper.py .. include:: ../global.rst diff --git a/docs/source/code_docs/webapp.rst b/docs/source/code_docs/webapp.rst index 1b5893d2..f255825c 100644 --- a/docs/source/code_docs/webapp.rst +++ b/docs/source/code_docs/webapp.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/webapp.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/webapp.py .. include:: ../global.rst diff --git a/docs/source/code_docs/youtube_dl_helper.rst b/docs/source/code_docs/youtube_dl_helper.rst index ed0bac8c..8dcd6203 100644 --- a/docs/source/code_docs/youtube_dl_helper.rst +++ b/docs/source/code_docs/youtube_dl_helper.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/Contents/Code/youtube_dl_helper.py +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/youtube_dl_helper.py .. include:: ../global.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 74148f9e..d4ae66dc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,7 +7,6 @@ # standard imports from datetime import datetime import os -import re import sys @@ -37,8 +36,8 @@ author = 'ReenigneArcher' # The full version, including alpha/beta/rc tags -with open(os.path.join(root_dir, 'CHANGELOG.md'), 'r') as f: - version = re.search(r"\[((\d+)\.(\d+)\.(\d+))]", str(f.read())).group(1) +# https://docs.readthedocs.io/en/stable/reference/environment-variables.html#envvar-READTHEDOCS_VERSION +version = os.getenv('READTHEDOCS_VERSION', 'dirty') # -- General configuration --------------------------------------------------- @@ -80,6 +79,15 @@ # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] +# These paths are either relative to html_static_path +# or fully qualified paths (eg. https://...) +# html_css_files = [ +# 'css/custom.css', +# ] +# html_js_files = [ +# 'js/custom.js', +# ] + # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'sphinx_rtd_theme' diff --git a/docs/source/contributing/build.rst b/docs/source/contributing/build.rst index e14ec16f..c12fccbe 100644 --- a/docs/source/contributing/build.rst +++ b/docs/source/contributing/build.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/contributing/build.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/contributing/build.rst Build ===== diff --git a/docs/source/contributing/contributing.rst b/docs/source/contributing/contributing.rst index d64aca4e..5ed92221 100644 --- a/docs/source/contributing/contributing.rst +++ b/docs/source/contributing/contributing.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/contributing/contributing.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/contributing/contributing.rst Contributing ============ diff --git a/docs/source/contributing/database.rst b/docs/source/contributing/database.rst index 94229fc2..92ed3bd5 100644 --- a/docs/source/contributing/database.rst +++ b/docs/source/contributing/database.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/contributing/database.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/contributing/database.rst Database ======== diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index e6770893..04033c10 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/contributing/testing.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/contributing/testing.rst Testing ======= diff --git a/docs/source/index.rst b/docs/source/index.rst index 1c3a521d..706d27be 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/LizardByte/Themerr-plex/tree/nightly/docs/source/index.rst +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/docs/source/index.rst Table of Contents =================