-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Docs: Add common build failures to FAQ #12527
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
base: main
Are you sure you want to change the base?
Conversation
Documentation build overview
Show files changed (6 files in total): 📝 6 modified | ➕ 0 added | ➖ 0 deleted
|
|
hey @stsewd , @ericholscher can you review this, i would really appreciate if it gets merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check this lines I commented (line 345 and 346)
| pre_build: | ||
| # Generate the Sphinx configuration for this Jupyter Book so it builds. | ||
| - "jupyter-book config sphinx docs/" | ||
| Common Build Failures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why no line break above common build failures?
| # Generate the Sphinx configuration for this Jupyter Book so it builds. | ||
| - "jupyter-book config sphinx docs/" | ||
| Common Build Failures | ||
| ===================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why two main heading (===)?
Closes #4729
This PR adds a new section to the FAQ page documenting common build failures and their solutions, including issues with dependencies and build timeouts.