From e1ca6274e4fa8fc903e16361907247f34d5151f6 Mon Sep 17 00:00:00 2001 From: Alexander Piskun <13381981+bigcat88@users.noreply.github.com> Date: Mon, 11 Mar 2024 10:18:45 +0300 Subject: [PATCH] removed docs from GH pages (#1312) Signed-off-by: Alexander Piskun --- .../{tests.yml => analysis-coverage.yml} | 2 +- .github/workflows/docs-check.yml | 25 ----------- .github/workflows/docs.yml | 43 ------------------- .readthedocs.yaml | 28 +++--------- README.md | 10 ++--- 5 files changed, 13 insertions(+), 95 deletions(-) rename .github/workflows/{tests.yml => analysis-coverage.yml} (99%) delete mode 100644 .github/workflows/docs-check.yml delete mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/tests.yml b/.github/workflows/analysis-coverage.yml similarity index 99% rename from .github/workflows/tests.yml rename to .github/workflows/analysis-coverage.yml index 35fc411d298..a68fa70694a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/analysis-coverage.yml @@ -1,4 +1,4 @@ -name: Python (npm) tests +name: Analysis & Coverage on: pull_request: diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml deleted file mode 100644 index 3ba49b297b2..00000000000 --- a/.github/workflows/docs-check.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Docs check -on: - pull_request: - -permissions: - contents: read - -jobs: - build_docs: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.10' - - - name: Install Docs dependencies - run: | - pip install poetry==1.6.1 - poetry install --with=docs - - - name: Build and push Docs - run: | - make html SPHINXOPTS="-W" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index c395494b62e..00000000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: Docs -on: - push: - branches: [ master ] - -permissions: - contents: read - -jobs: - build_push_docs: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.10' - - - name: Install Docs dependencies - run: | - pip install poetry==1.6.1 - poetry install --with=docs - - - name: Build and push Docs - run: | - export CHANGES_DATE=`date -d"@$(git log -1 --pretty=%ct)" --iso-8601=seconds` - make html - git config --global user.name nextcloud-bot - git config --global user.email "nextcloud-bot@users.noreply.github.com" - docroot=`mktemp -d` - rsync -av "docs/_build/html/" "${docroot}/" - pushd "${docroot}" - git init - git remote add deploy "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" - git checkout -b gh-pages - touch .nojekyll - git add . - msg="Docs: commit ${GITHUB_SHA} made on ${CHANGES_DATE} from ${GITHUB_REF} by ${GITHUB_ACTOR}" - git commit -am "${msg}" - git push deploy gh-pages --force - popd - env: - GITHUB_TOKEN: ${{ secrets.TOKEN_DOCS }} diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dd2aa46c895..5fc3efd649c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,35 +1,21 @@ -# Read the Docs configuration file for Sphinx projects -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required version: 2 -# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: python: "3.12" - # You can also specify other tool versions: - # nodejs: "20" - # rust: "1.70" - # golang: "1.20" + jobs: + post_create_environment: + - pip install poetry==1.6.1 + - poetry config virtualenvs.create false + post_install: + - poetry install --with docs + -# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py - # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs - # builder: "dirhtml" - # Fail on all warnings to avoid broken references - # fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub # formats: # - pdf # - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt diff --git a/README.md b/README.md index 976213f46b4..d39381377a5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # Nextcloud App Store -[![Build Status](https://travis-ci.org/nextcloud/appstore.svg?branch=master)](https://travis-ci.org/nextcloud/appstore) +[![Analysis & Coverage](https://github.com/nextcloud/appstore/actions/workflows/analysis-coverage.yml/badge.svg)](https://github.com/nextcloud/appstore/actions/workflows/analysis-coverage.yml) [![codecov](https://codecov.io/gh/nextcloud/appstore/branch/master/graph/badge.svg?token=ABLI0g5G9q)](https://codecov.io/gh/nextcloud/appstore) -[![Docs](https://github.com/nextcloud/appstore/actions/workflows/docs.yml/badge.svg)](https://nextcloud.github.io/appstore/) -[![iRequirements Status](https://requires.io/github/nextcloud/appstore/requirements.svg?branch=master)](https://requires.io/github/nextcloud/appstore/requirements/?branch=master) +[![Documentation Status](https://readthedocs.org/projects/nextcloudappstore/badge/?version=latest)](http://nextcloudappstore.readthedocs.io/en/latest/?badge=latest) [![Package.json Status](https://david-dm.org/nextcloud/appstore.svg)](https://david-dm.org/nextcloud/appstore) + +![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/846/badge)](https://bestpractices.coreinfrastructure.org/projects/846) [![License](https://img.shields.io/badge/license-AGPLv3+-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html) -[![IRC](https://img.shields.io/badge/irc%20channel-%23nextcloud--dev%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-dev) A new app store for Nextcloud apps built with Django. Up and running at [https://apps.nextcloud.com](https://apps.nextcloud.com). We **do not handle Nextcloud integration**. Nextcloud integration is handled in the [Nextcloud Server repository](https://github.com/nextcloud/server). ## Documentation -Documentation including setup and API specification is available [on the GitHub Pages](https://nextcloud.github.io/appstore/) +Documentation including setup and API specification is [available on Read the Docs](https://nextcloudappstore.readthedocs.io/en/latest/) ## Contributing If you want to help in developing the App Store, translating or filing bugs and feature requests, please consult the [contributing guidelines](https://github.com/nextcloud/appstore/blob/master/CONTRIBUTING.md)