From 58f1258a116fd3534bf4553920b43c9fac8c5fa4 Mon Sep 17 00:00:00 2001 From: emrgnt-cmplxty <68796651+emrgnt-cmplxty@users.noreply.github.com> Date: Wed, 5 Jul 2023 21:39:38 -0400 Subject: [PATCH] Feature/fix read the docs (#121) * Improve docs and nbs * update readthedocs * fix yaml * remove version tag * add build yml --- .github/workflows/build-docs.yml | 30 ++++++++++++++++++++++++++++++ .readthedocs.yaml | 6 +++--- 2 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 00000000..b9c80d6d --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,30 @@ +# .github/workflows/build-docs.yml +name: Build Documentation + +on: + push: + branches: + - main # or replace with your default branch + pull_request: + branches: + - main # or replace with your default branch + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Check out source + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.9 # or the version you are using + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r automata/docs/requirements.txt # replace with your requirements file path + + - name: Build docs + run: make -C automata/docs/ html # replace with your Sphinx docs directory diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c3ec1d3a..4fcc8f34 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,6 +26,6 @@ sphinx: # 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 +python: + install: + - requirements: automata/docs/requirements.txt