Skip to content

Update theme to show hidden ToC in sidebar #12949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashb merged 1 commit into from
Dec 9, 2020
Merged

Update theme to show hidden ToC in sidebar #12949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions airflow/serialization/serialized_objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@
_OPERATOR_EXTRA_LINKS: Set[str] = {
"airflow.operators.trigger_dagrun.TriggerDagRunLink",
"airflow.sensors.external_task.ExternalTaskSensorLink",
# Deprecated names, so that existing serialized dags load straight away.
"airflow.operators.dagrun_operator.TriggerDagRunLink",
"airflow.sensors.external_task_sensor.ExternalTaskSensorLink",
Copy link
Member Author

@ashb ashb Dec 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops this shouldn't have been in this PR.

Bad Ash, no 🍪

}


Expand Down
7 changes: 3 additions & 4 deletions docs/apache-airflow/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,9 @@ similar from a run to the next, this allows for clarity around
unit of work and continuity.


Content
-------
.. toctree::
:maxdepth: 1
:hidden:
:caption: Content

Home <self>
project
Expand Down Expand Up @@ -108,7 +107,7 @@ Content
privacy_notice

.. toctree::
:maxdepth: 1
:hidden:
:caption: References

Operators and hooks <operators-and-hooks-ref>
Expand Down
6 changes: 4 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,10 @@ def _get_rst_filepath_from_path(filepath: str):
html_show_copyright = False

# Theme configuration
sphinx_airflow_theme_navbar_links = [{'href': '/index.html', 'text': 'Documentation'}]
sphinx_airflow_theme_hide_website_buttons = True
html_theme_options = {
'hide_website_buttons': True,
}

# A dictionary of values to pass into the template engine’s context for all pages.
html_context = {
# Google Analytics ID.
Expand Down
4 changes: 2 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ def write_version(filename: str = os.path.join(*[my_dir, "airflow", "git_version


_SPHINX_AIRFLOW_THEME_URL = (
"https://github.com/apache/airflow-site/releases/download/v0.0.1/"
"sphinx_airflow_theme-0.0.1-py3-none-any.whl"
"https://github.com/apache/airflow-site/releases/download/v0.0.2/"
"sphinx_airflow_theme-0.0.2-py3-none-any.whl"
)

# 'Start dependencies group' and 'Start dependencies group' are mark for ./scripts/ci/check_order_setup.py
Expand Down