You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/03/22 22:04:57 UTC

[GitHub] [airflow] mik-laj opened a new issue #14939: The documentation for Airflow 1.10+ with our theme doesn't look good

mik-laj opened a new issue #14939:
URL: https://github.com/apache/airflow/issues/14939


   Hello,
   
   After building documentation with our theme, there are problems with loading all styles.
   
   To build the documentation for. Airflow 1.10.15, I had to make some minor changes to the theme
   Register CSS stylesheet at `builder-inited` event (`/Users/X/.pyenv/versions/3.8.7/envs/airflow-1-10/lib/python3.8/site-packages/sphinx_airflow_theme/__init__.py`)
   ```diff
   +def setup_builder_inited(app):
   +    app.add_css_file('_gen/css/main-custom.min.css')
   # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
    def setup(app: Sphinx):
        app.add_html_theme('sphinx_airflow_theme', path.abspath(path.dirname(__file__)))
   -    app.connect("builder-inited", setup_builder_inited)
   +    app.add_css_file('_gen/css/main-custom.min.css')
        app.connect("config-inited", setup_my_func)
   ```
   2. Add this theme as extension (/Users/X/devel/airflow/airflow-1-10/docs/conf.py)
   ```diff
   extensions = [
       'sphinx.ext.autodoc',
       'sphinx.ext.coverage',
       'sphinx.ext.viewcode',
       'sphinx.ext.graphviz',
       'sphinxarg.ext',
       'sphinxcontrib.httpdomain',
       'sphinxcontrib.jinja',
       'sphinx.ext.intersphinx',
       'autoapi.extension',
       'exampleinclude',
       'docroles',
       'removemarktransform',
       'sphinx_copybutton',
   +    'sphinx_airflow_theme',
   ]
   ```
   I don't have time to find out what the root cause is, but I hope this information is helpful.


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