You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2019/07/22 06:43:00 UTC

[jira] [Commented] (AIRFLOW-5014) Latest sphinx extensions cause doc build to fail

    [ https://issues.apache.org/jira/browse/AIRFLOW-5014?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16889950#comment-16889950 ] 

ASF GitHub Bot commented on AIRFLOW-5014:
-----------------------------------------

potiuk commented on pull request #5636: [AIRFLOW-5014] Fix sphinx doc problem and leaves API docs
URL: https://github.com/apache/airflow/pull/5636
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-5014
   
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   This change fixes autodoc generated documentation problems but also
   leaves generated .rst files in _api folder so that it is easier to
   debug and fix problems like that in the future.
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   No tests.
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
   ### Code Quality
   
   - [x] Passes `flake8`
   
 
----------------------------------------------------------------
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:
users@infra.apache.org


> Latest sphinx extensions cause doc build to fail
> ------------------------------------------------
>
>                 Key: AIRFLOW-5014
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5014
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: ci, documentation
>    Affects Versions: 1.10.4, 2.0.0
>            Reporter: Jarek Potiuk
>            Priority: Major
>
> Those are the errors:
> {noformat}
> /opt/airflow/docs/_api/airflow/contrib/hooks/ftp_hook/index.rst:132: WARNING: Unexpected indentation.
> /opt/airflow/docs/_api/airflow/contrib/hooks/ftp_hook/index.rst:138: WARNING: Unexpected indentation.
> /opt/airflow/docs/_api/airflow/contrib/hooks/ftp_hook/index.rst:142: WARNING: Block quote ends without a blank line; unexpected unindent.
> /opt/airflow/docs/_api/airflow/contrib/operators/gcs_operator/index.rst:64: WARNING: Field list ends without a blank line; unexpected unindent.
> /opt/airflow/docs/_api/airflow/hooks/http_hook/index.rst:95: WARNING: Unexpected indentation.
> /opt/airflow/docs/_api/airflow/hooks/http_hook/index.rst:98: WARNING: Block quote ends without a blank line; unexpected unindent.
> /opt/airflow/docs/_api/airflow/hooks/http_hook/index.rst:100: WARNING: Unexpected indentation.
> /opt/airflow/docs/_api/airflow/hooks/http_hook/index.rst:102: WARNING: Block quote ends without a blank line; unexpected unindent.
> {noformat}



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)