Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ReadTheDocs.io build break #390

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Fix ReadTheDocs.io build break #390

merged 1 commit into from
Jun 5, 2024

Conversation

oshoma
Copy link
Collaborator

@oshoma oshoma commented Jun 5, 2024

ReadTheDocs build breaks on this line which I recently added to docs/requirements.txt:

-e ../src  # local dependency with editable install

I believe removing this line will fix the build. I don't know of a way to test readthedocs.io build
process locally, so I guess we should just push this and see what happens.

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Maintenance
  • New release

Checklists

To speed up the review process, please follow these checklists:

Development

  • The Pull Request is small and focused on one topic
  • Lint rules pass locally (make format && make lint)
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development (make test)
  • The changes generate no new warnings (or explain any new warnings and why they're ok)
  • Commit messages are detailed
  • Changed code is self-explanatory and/or I added comments
  • I updated the documentation (docstrings, /docs)
    See the testing guidelines for help on tests, especially those involving web services.

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached.
  • I have performed a self-review of my code
  • Issue from task tracker has a link to this pull request

💔 Thank you for submitting a pull request!

RTeadTheDocs build breaks on this line which I added  to docs/requirements.txt:
```
-e ../src  # local dependency with editable install
```

I believe removing this line will fix the build.
@oshoma oshoma requested a review from amirfz June 5, 2024 21:20
@amirfz amirfz merged commit 0677ca6 into main Jun 5, 2024
4 checks passed
@amirfz amirfz deleted the fix-readthedocs-build branch June 5, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants