mik-laj commented on issue #11423:
URL: https://github.com/apache/airflow/issues/11423#issuecomment-730688382


   Hello.
   
   Today I would like to discuss the next step - Sphinx theme for our 
documentation. This theme is currently being developed in the 
[`airflow-site`](https://github.com/apache/airflow-site) repository, but the 
theme package for installation is not published anywhere. Quite simply, if you 
want to build a production documentation, you have to install this theme on 
your own. This is reasonably OK if we only build documentation once every few 
months, but this is far from ideal. 
   
   The production and development documentation looks completely different. 
This means that if there is an error in the theme, we find out about it after 
publishing the documentation and any change is then much more difficult. This 
usually means that we have to edit each HTML file individually.
   
   I would like to improve it now and install theme in Breeze and also provide 
a way to install this theme if you want to build documentation locally. I would 
not like to publish this package on Pypi so as not to clutter the public 
repository with packages that will not be used by other projects.
   
   I think the easiest way is to build a theme on Github Action for 
airfllow-site and then publish theme to S3. Then we will be able to install the 
theme with the command:
   ```
   pip install airflow-sphinx-theme --extra-index-url 
https://apache-airflow-pypi.s3-website.eu-central-1.amazonaws.com/
   ```
   I was thinking about installing with pip+git:
   ```
   pip install git+https://github.com
   ```
   Unfortunately, this won't work as this theme has a complex build process. We 
must first build a website to generate the necessary artifacts to build a theme 
package.
   
   CC: @potiuk @ryw @kaxil 


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


Reply via email to