Skip to content

Fix for ReadTheDocs dependencies #2

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 5, 2024
Merged

Fix for ReadTheDocs dependencies #2

merged 2 commits into from
Jun 5, 2024

Conversation

@marshallmcdonnell
Copy link
Collaborator

@marshallmcdonnell marshallmcdonnell commented Jun 5, 2024

The issue:

  • we have the docs deps under PDM dev deps; this is not accessible via readthedocs extra requirements install
  • Instead, moving the docs deps to "optional dependencies" in pyproject.toml; was able to use pip install .[docs] locally and get furo theme in my environment 👍
  • Did switch the name of the docs deps from doc -> docs

@marshallmcdonnell marshallmcdonnell self-assigned this Jun 5, 2024
@marshallmcdonnell
Copy link
Collaborator Author

marshallmcdonnell commented Jun 5, 2024

NOTE: CI now will test the build of the docs on PRs!

image

@marshallmcdonnell marshallmcdonnell merged commit e0b33c8 into main Jun 5, 2024
@marshallmcdonnell marshallmcdonnell deleted the fix-rtd-deps branch June 5, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lance-Drane Lance-Drane Awaiting requested review from Lance-Drane

Assignees

@marshallmcdonnell marshallmcdonnell

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@marshallmcdonnell