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

Update readthedocs.yml #2014

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Update readthedocs.yml #2014

merged 2 commits into from
Sep 6, 2024

Conversation

berl
Copy link
Collaborator

@berl berl commented Aug 21, 2024

make readthedocs config compatible with latest requirements

make readthedocs config compatible with latest requirements
shachafl
shachafl previously approved these changes Aug 24, 2024
@shachafl
Copy link
Collaborator

shachafl commented Aug 24, 2024

@berl I approved your PR, but the readthedocs.yml file might be missing:

# Build documentation in the docs/ directory with Sphinx
sphinx:
   configuration: docs/source/conf.py

If you don't think it is necessary, you can "squash and merge" the branch

@shachafl shachafl self-requested a review September 6, 2024 01:40
@shachafl shachafl dismissed their stale review September 6, 2024 01:44

After testing the changes, I got an error that needs fixing

Copy link
Collaborator

@shachafl shachafl left a comment

Choose a reason for hiding this comment

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

This version failed to build and so I suggest the following for readthedocs.yml (below).

# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
    os: ubuntu-22.04
    tools:
        python: "3.10"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/source/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references
  fail_on_warning: true

python:
    install:
        - requirements: requirements/REQUIREMENTS-CI.txt
        - method: pip
          path: .

per lschachaf's fix
Copy link
Collaborator

@shachafl shachafl left a comment

Choose a reason for hiding this comment

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

Thanks for the quick update.
I found a few minor issues when building from my fork, but my guess is that they are related to the Sphinx built and configuration.
I will address them in a separate PR

@shachafl shachafl merged commit f56f3d2 into master Sep 6, 2024
25 checks passed
@shachafl shachafl deleted the berl-patch-1 branch September 6, 2024 17:04
shachafl added a commit to shachafl/starfish that referenced this pull request Sep 6, 2024
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