diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 6dca44f..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: Documentation -on: - pull_request: - branches: - - release - - develop - paths: - - 'docs/**' - - 'lib/pytest-lsp/**' - push: - branches: - - release - - develop - paths: - - 'docs/**' - - 'lib/pytest-lsp/**' - -jobs: - docs: - name: Documentation - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - - uses: actions/setup-python@v4 - with: - python-version: "3.10" - - - run: | - set -e - - python --version - python -m pip install --upgrade pip - python -m pip install -r docs/requirements.txt - - name: Setup Environment - - - id: build - run: | - set -e - - cd docs - make html - name: Build Docs - - - name: 'Upload Aritfact' - uses: actions/upload-artifact@v3 - with: - name: 'docs' - path: 'docs/_build/${{ steps.build.outputs.version }}' - - - name: 'Publish Docs' - uses: JamesIves/github-pages-deploy-action@v4 - with: - branch: gh-pages - folder: docs/_build/${{ steps.build.outputs.version }} - target-folder: docs/${{ steps.build.outputs.version }} - clean: true - if: success() && ( startsWith(github.ref, 'refs/heads/release') || startsWith(github.ref, 'refs/heads/develop') ) diff --git a/.github/workflows/lsp-devtools-release.yml b/.github/workflows/lsp-devtools-release.yml index cb486da..05d20b2 100644 --- a/.github/workflows/lsp-devtools-release.yml +++ b/.github/workflows/lsp-devtools-release.yml @@ -1,4 +1,4 @@ -name: Release: lsp-devtools +name: 'Release: lsp-devtools' on: push: diff --git a/.github/workflows/pytest-lsp-release.yml b/.github/workflows/pytest-lsp-release.yml index 4380593..4903dd5 100644 --- a/.github/workflows/pytest-lsp-release.yml +++ b/.github/workflows/pytest-lsp-release.yml @@ -1,4 +1,4 @@ -name: Release: pytest-lsp +name: 'Release: pytest-lsp' on: push: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c1202c..c5c5f50 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,6 +4,7 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: + - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..411b29d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# 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.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# 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/docs/requirements.txt b/docs/requirements.txt index 81a7b98..8476ae3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,5 +4,5 @@ sphinx sphinx-copybutton sphinx-design furo -git+https://github.com/openlawlibrary/pygls.git#egg=pygls +pygls>=1.1.0 -e lib/pytest-lsp