Skip to content

Commit

Permalink
Fix readthedocs build (#45)
Browse files Browse the repository at this point in the history
Remove restrictions on dev dependencies
  • Loading branch information
medley56 committed Apr 1, 2024
1 parent 69386bf commit b3138b5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ build:
post_create_environment:
# Install poetry
- pip install poetry
# Tell poetry to not use a virtual environment
# Tell poetry to not create a new virtual environment but use the current one
- poetry config virtualenvs.create false
post_install:
# Install dependencies. Our doc building dependencies are part of the dev group
- poetry install
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install

sphinx:
configuration: docs/source/conf.py
9 changes: 9 additions & 0 deletions docs/source/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ To run all tests in docker containers (tests against many versions of python), r
docker-compose up --build && docker-compose down
```


## Making a Pull Request
Feel free to fork this repo and submit a PR!
- If you are working on an issue, link your PR to that issue.
- All PRs should be destined for the `main` branch (trunk-based development).
- Reviews are required before merging and our automated tests must pass.
- Please fill out the PR template that is populated when creating a PR in the GitHub interface.


## Release Process
Reference: [https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)

Expand Down
20 changes: 10 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ python = ">=3.8"
bitstring = ">=3.0.0"

[tool.poetry.group.dev.dependencies]
pylint = "^2"
pytest = "^6"
pytest-randomly = "^3"
pytest-cov = "^3"
pyyaml = "^6.0"
sphinx = "^6.1.3"
myst-parser = "^1.0.0"
sphinx-autoapi = "^2.0.1"
sphinx-rtd-theme = "^1.2.0"
coverage = "^7.2.5"
pylint = "*"
pytest = "*"
pytest-randomly = "*"
pytest-cov = "*"
pyyaml = "*"
sphinx = "*"
myst-parser = "*"
sphinx-autoapi = "*"
sphinx-rtd-theme = "*"
coverage = "*"

[tool.poetry.group.examples]
optional = true
Expand Down

0 comments on commit b3138b5

Please sign in to comment.