Skip to content

Commit

Permalink
Merge pull request #218 from nicolasbock/fix_docs
Browse files Browse the repository at this point in the history
Add readthedocs configuration file
  • Loading branch information
stkw0 authored Apr 20, 2024
2 parents b427f23 + 1725dee commit 5601686
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/workflows/functional.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ jobs:
- name: Install
run: |
sudo apt install python3-pip
sudo pip install -r requirements.txt
pip list --verbose
python3 setup.py install
Expand Down
24 changes: 24 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# .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 version of Python 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

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
- method: setuptools
path: .
File renamed without changes.
5 changes: 2 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
envlist = py3, bandit, pep8

[testenv]
deps =
-rrequirements.txt
-rtest-requirements.txt
deps = -r test-requirements.txt
install_command =
pip install {opts} --upgrade {packages} pip setuptools
commands =
pip list --outdated
python -m unittest --verbose

[testenv:docs]
deps = -r docs/requirements.txt
commands =
sphinx-apidoc --force --output-dir docs ebuildtester
sphinx-build -M html docs docs/_build
Expand Down

0 comments on commit 5601686

Please sign in to comment.