potiuk commented on PR #24895:
URL: https://github.com/apache/airflow/pull/24895#issuecomment-1179041364

   Well. Not sure - seems like really "cryptic" error from Sphinx (which is 
known from rather cryptic messages). Look at the actual output of the sphix 
build (Above the summary) and you will find the warning there.
   
   Also there is apparently a bug (@mik-laj?) that in this case our error 
parsing added second .rst to display the line of .rst file that was actually 
causing it.
   
   However I made an intelligent guess and looked closely. From what I see, I 
think the lines below are all indented ONE SPACE MORE than all the others. so 
maybe fixing that will help.
   
   ```
       Connection types <connections/elasticsearch>
       Logging for Tasks <logging/index>
       Elasticsearch hook with native Python client <hooks/elasticsearch>
   ```
   
   Also few other tips - and ways I deal with similar cases (been there, done 
that many times). You can easily iterate locally with it (and this is what I do 
when I have similar issues with docs):
   
   ```
   breeze build-docs --package-filter apache-airlfow-provider-elasticsearch 
--docs-only
   ```
   
   This will run much faster than CI circle and allows you to also take a look 
at sphinx-generated intermediate artifacts which usually helps with debugging 
it. 
   
   If all else fails. I usually fall-back to just looking at teh source code of 
Sphins and finding what the error message actually means (i.e. when it will be 
produced). In this case: `WARNING: non-whitespace stripped by dedent` - my 
intelligent guess is that Sphinx took the first indentation depth and stripped 
the same identation from the next block (which lead to stripping some non-white 
space character) - that's why the guess that one-space-more of indentation in 
the first block might be the reason. But I have not looked it up in the sources 
yet.


-- 
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.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to