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

Docs #1139

Merged
merged 10 commits into from
Jan 30, 2024
Merged

Docs #1139

merged 10 commits into from
Jan 30, 2024

Conversation

ddkohler
Copy link
Contributor

@ddkohler ddkohler commented Aug 10, 2023

Changes

avoid deprecation of Read the Docs

builds on readthedocs are currently failing, so this is an attempt to remedy this

Copy link
Contributor

@pcruzparri pcruzparri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading the readthedocs documentation, I think that what we had would still work. However, I provided an alternative in case the docs/requirements.txt is necessary. Additionally, from one of the examples on their documentation of the requirements file, another way is to add an install option to python as shown below:

python:
  version: 3.8
  pip_install: true
  install:
    path: ..
    extra_requirements: 
      - docs

which should similarly run pip install ..[docs] during building and is what is needed.

Thoughts?

@ddkohler
Copy link
Contributor Author

I will try to mirror the attune configs setup, since they are still working well.

@ddkohler ddkohler marked this pull request as ready for review January 25, 2024 21:29
@ddkohler ddkohler requested a review from pcruzparri January 26, 2024 18:33
@kameyer226 kameyer226 merged commit 6f9c549 into master Jan 30, 2024
17 checks passed
@kameyer226 kameyer226 deleted the docs branch January 30, 2024 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants