Skip to content

Commit

Permalink
update the documentation setting
Browse files Browse the repository at this point in the history
  • Loading branch information
Alleria1809 committed Jul 4, 2024
1 parent ba5827a commit 978c331
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 8 deletions.
8 changes: 0 additions & 8 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,6 @@ jobs:
run: |
poetry config virtualenvs.create false # Avoid creating a virtual environment
poetry install # Install dependencies as specified in pyproject.toml
- name: Check Current 'document.yaml' Configuration
run: |
echo "Checking in default docs directory:"
cat docs/document.yaml || echo "No document.yaml in default docs directory."
echo "Checking in alternative directory:"
cat path/to/alternative/document.yaml || echo "No document.yaml in alternative directory."
working-directory: ${{ github.workspace }}
- name: Build documentation using Makefile
run: |
Expand Down
32 changes: 32 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# .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.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# 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

0 comments on commit 978c331

Please sign in to comment.