[GitHub] [airflow] mik-laj commented on pull request #12527: Move providers references to separate packages + Disabling spell-check in separate job

[GitBox <gi...@apache.org>]

mik-laj commented on pull request #12527:
URL: https://github.com/apache/airflow/pull/12527#issuecomment-731562884


   As far as I know, this documentation building doesn't mean the spelling will be checked. These are two separate steps.
   
   This change causes spelling and building to be done in one job on the CI, but if the user wants to iterate locally over the documentation in small steps, they can still do so.  If they don't build all the documentation beforehand (a situation similar to spell check in a separate CI Job), the process may end with a message that not all was successful, but the spelling will be checked and the user can start working on other changes. If they want a full check, they can send the change to the CI.
   
   All this will allow us to shorten the iteration time, because we will only perform selected steps and iterate over them.
   ```
   $ time ./build_docs.py --spellcheck-only --package apache-airflow
   real	1m10.113s
   user	0m54.709s
   sys	0m12.332s
   ```
   ```
   $ time ./build_docs.py --docs-only --package apache-airflow
   real	1m32.180s
   user	1m24.968s
   sys	0m5.662s
   ```
   
   The documentation for building the documentation has been. moved to [/docs/README.rst](https://github.com/apache/airflow/blob/master/docs/README.rst) to make it easier to find. For now this file may not be very visible, but I will clean up this directory a bit soon and it will be the only .rst file in this directory. All other files will be in subdirectories following to the structure of the output directory.
   


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