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

Add .readthedocs.yaml file #246

Merged
merged 1 commit into from Apr 24, 2024
Merged

Conversation

jeffwidman
Copy link
Member

@jeffwidman jeffwidman commented Apr 23, 2024

Add .readthedocs.yaml file.

This config file is now required by RTD in order to build the docs.

Fix #228

@jeffwidman

This comment was marked as outdated.

@jeffwidman jeffwidman changed the title Add .readthedocs.yaml file Fix ReadTheDocs builds Apr 23, 2024
@jeffwidman jeffwidman marked this pull request as draft April 23, 2024 21:53
@jeffwidman jeffwidman force-pushed the add-read-the-docs-config-file branch from 26c1b07 to 36340ad Compare April 23, 2024 23:29
@jeffwidman

This comment was marked as outdated.

@jeffwidman
Copy link
Member Author

jeffwidman commented Apr 24, 2024

Actually, all we need to make RTD do a local install of FDBT is:

python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs

And the todo about a docs extra requirement would be to install the custom flask theme for sphinx...

@jeffwidman jeffwidman force-pushed the add-read-the-docs-config-file branch 3 times, most recently from 88f0c7e to c059d91 Compare April 24, 2024 02:03
@jeffwidman jeffwidman changed the base branch from master to install-custom-theme-using-extras-rather-then-git-submodule April 24, 2024 02:03
@jeffwidman jeffwidman changed the title Fix ReadTheDocs builds Add .readthedocs.yaml file Apr 24, 2024
@jeffwidman jeffwidman marked this pull request as ready for review April 24, 2024 02:04
@jeffwidman
Copy link
Member Author

This is now stacked on top of #250 and finally we have RTD fully working again!

Base automatically changed from install-custom-theme-using-extras-rather-then-git-submodule to master April 24, 2024 14:40
This config file is now required by RTD in order to build the docs.
@jeffwidman jeffwidman force-pushed the add-read-the-docs-config-file branch from c059d91 to b51e77e Compare April 24, 2024 14:43
@jeffwidman jeffwidman enabled auto-merge (squash) April 24, 2024 14:44
@jeffwidman jeffwidman merged commit c65c6b9 into master Apr 24, 2024
11 checks passed
@jeffwidman jeffwidman deleted the add-read-the-docs-config-file branch April 24, 2024 14:46
@macnewbold
Copy link
Contributor

Thanks @jeffwidman for all your work on getting this fixed up!

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.

ReadTheDocs builds are broken
3 participants