Skip to content
This repository has been archived by the owner on Mar 16, 2024. It is now read-only.

Commit

Permalink
Feature/fix read the docs (#121)
Browse files Browse the repository at this point in the history
* Improve docs and nbs

* update readthedocs

* fix yaml

* remove version tag

* add build yml
  • Loading branch information
emrgnt-cmplxty authored Jul 6, 2023
1 parent 9c45309 commit 58f1258
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 3 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 58f1258

Please sign in to comment.