diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml deleted file mode 100644 index 7f957c456..000000000 --- a/.github/workflows/build_docs.yaml +++ /dev/null @@ -1,45 +0,0 @@ -# -# Copyright 2021 Graviti. Licensed under MIT License. -# - ---- -name: Build Docs - -on: [push, pull_request] - -jobs: - build: - runs-on: ${{ matrix.os }} - strategy: - matrix: - python-version: [3.8.0] - os: [ubuntu-20.04] - - steps: - - uses: actions/checkout@v2 - - - name: Set up ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.6 - bundler-cache: true - - - name: Cache python ${{ matrix.python-version }} - uses: actions/cache@v2 - with: - path: /opt/hostedtoolcache/Python/${{ matrix.python-version }} - key: ${{ matrix.os }}-sphinx-${{ hashFiles('requirements.txt') }} - - - name: Set up python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} - - - name: Install dependencies - run: | - pip install sphinx sphinx_rtd_theme - pip install -r requirements.txt - - - name: Build docs - id: build_docs - run: python -m sphinx -T -E -d build/doctrees -D language=en docs/source build/html -W diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..0571c06a8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +--- +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + fail_on_warning: true + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.8 + install: + - requirements: requirements.txt