Skip to content

bpo-37860: re-add netlify.toml to set up deploy previews for docs #92852

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
merged 9 commits into from
Dec 6, 2022
Merged

bpo-37860: re-add netlify.toml to set up deploy previews for docs #92852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6a80a21
Revert "bpo-46184: remove `netlify.toml` (#30272)"
epicfaace May 16, 2022
22a55a5
Delete runtime.txt
epicfaace May 16, 2022
d2b7cb4
Create runtime.txt
epicfaace May 16, 2022
b2a5dd2
Delete runtime.txt
epicfaace May 16, 2022
882fd4c
Update netlify.toml
epicfaace May 16, 2022
adbd5dd
Update netlify.toml
epicfaace May 16, 2022
e3321c6
Add netlify badge
epicfaace Jun 19, 2022
3268970
Update Doc/tools/templates/layout.html
epicfaace Jun 19, 2022
9a9513c
Update layout.html
epicfaace Jun 19, 2022
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
8 changes: 8 additions & 0 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@
# Short title used e.g. for <title> HTML tags.
html_short_title = '%s Documentation' % release

# Deployment preview information, from Netlify
# (See netlify.toml and https://docs.netlify.com/configure-builds/environment-variables/#git-metadata)
html_context = {
"is_deployment_preview": os.getenv("IS_DEPLOYMENT_PREVIEW"),
"repository_url": os.getenv("REPOSITORY_URL"),
"pr_id": os.getenv("REVIEW_ID")
}

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
Expand Down
13 changes: 13 additions & 0 deletions Doc/tools/templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@
<a href="/3/{{ pagename }}{{ file_suffix }}">{% trans %} Python documentation for the current stable release{% endtrans %}</a>.
</div>
{%- endif %}

{%- if is_deployment_preview %}
<div id="deployment-preview-warning" style="padding: .5em; text-align: center; background-color: #fff2ba; color: #6a580e;">
<div style="float: right; margin-top: -10px; margin-left: 10px;">
<a href="https://www.netlify.com">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
</a>
</div>
{% trans %}This is a deploy preview created from a <a href="{{ repository_url }}/pull/{{ pr_id }}">pull request</a>.
For authoritative documentation, see the {% endtrans %}
<a href="https://docs.python.org/3/{{ pagename }}{{ file_suffix }}">{% trans %} the current stable release{% endtrans %}</a>.
</div>
{%- endif %}
{% endblock %}

{% block rootrellink %}
Expand Down
8 changes: 8 additions & 0 deletions netlify.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[build]
base = "Doc/"
command = "make html"
publish = "build/html"

[build.environment]
PYTHON_VERSION = "3.8"
IS_DEPLOYMENT_PREVIEW = "true"