RNHTTR opened a new issue #14051:
URL: https://github.com/apache/airflow/issues/14051
<!--
Welcome to Apache Airflow! For a smooth issue process, try to answer the
following questions.
Don't worry if they're not all applicable; just try to include what you can
:-)
If you need to include code snippets or logs, please put them in fenced code
blocks. If they're super-long, please use the details tag like
<details><summary>super-long log</summary> lots of stuff </details>
Please delete these comment blocks before submitting the issue.
-->
<!--
IMPORTANT!!!
PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
Please complete the next sections or the issue will be closed.
These questions are the first thing we need to know to understand the
context.
-->
**Apache Airflow version**: 2.0.0
**Kubernetes version (if you are using kubernetes)** (use `kubectl
version`): n/a
**Environment**:
- **Cloud provider or hardware configuration**: n/a
- **OS** (e.g. from /etc/os-release): n/a
- **Kernel** (e.g. `uname -a`): n/a
- **Install tools**: n/a
- **Others**: n/a
**What happened**:
A sphinx warning unrelated to spelling issues running `sphinx-build`
resulted in an instance of `SpellingError` to cause a docs build failure.
```
SpellingError(
file_path=None,
line_no=None,
spelling=None,
suggestion=None,
context_line=None,
message=(
f"Sphinx spellcheck returned non-zero exit status:
{completed_proc.returncode}."
)
)
# sphinx.errors.SphinxWarning:
/opt/airflow/docs/apache-airflow-providers-google/_api/drive/index.rst:document
isn't included in any toctree
```
The actual issue was that I failed to include an `__init__.py` file in a
directory that I created.
<!-- (please include exact error messages if you can) -->
**What you expected to happen**:
I think an exception should be raised unrelated to a spelling error.
Preferably one that would indicate that there's a directory that's missing an
init file, but at least a generic error unrelated to spelling
<!-- What do you think went wrong? -->
**How to reproduce it**:
Create a new plugin directory (e.g.
`airflow/providers/google/suite/sensors`) and don't include an `__init__.py`
file, and run `./breeze build-docs -- --docs-only -v`
<!---
As minimally and precisely as possible. Keep in mind we do not have access
to your cluster or dags.
If you are using kubernetes, please attempt to recreate the issue using
minikube or kind.
## Install minikube/kind
- Minikube https://minikube.sigs.k8s.io/docs/start/
- Kind https://kind.sigs.k8s.io/docs/user/quick-start/
If this is a UI bug, please provide a screenshot of the bug or a link to a
youtube video of the bug in action
You can include images using the .md style of
To record a screencast, mac users can use QuickTime and then create an
unlisted youtube video with the resulting .mov file.
--->
**Anything else we need to know**:
I'm specifically referring to lines 139 to 150 in
`docs/exts/docs_build/docs_builder.py`
<!--
How often does this problem occur? Once? Every time etc?
Any relevant logs to include? Put them here in side a detail tag:
<details><summary>x.log</summary> lots of stuff </details>
-->
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
