Skip to content
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.

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

bpo-37860: Add netlify deploy preview for docs #15288

Merged
merged 14 commits into from
Aug 21, 2019
5 changes: 5 additions & 0 deletions Doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Requirements for docs build on netlify
# Pin sphinx to version specified in .travis.yml
sphinx==2.0.1
Copy link
Contributor

Choose a reason for hiding this comment

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

@Mariatta Do you think that this should be pinned or float upward?

Copy link
Contributor Author

@epicfaace epicfaace Aug 21, 2019

Choose a reason for hiding this comment

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

I pinned it because that's how it was in .travis.yml.

https://github.com/python/cpython/blob/master/.travis.yml#L58

Actually, do you think it might be better to make .travis.yml to read from Doc/requirements.txt instead of specifying its own versions?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's do this. Keep it pinned for now but add a comment: # Pin sphinx to version specified in .travis.yml on the line above Sphinx in requirements.txt

Copy link
Contributor Author

@epicfaace epicfaace Aug 21, 2019

Choose a reason for hiding this comment

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

Done. I think it might be better to just include python -m pip install -r Docs/requirements.txt in .travis.yml though, so that we don't have to keep two files in sync, unless there's a reason not to do so?

Copy link
Contributor

Choose a reason for hiding this comment

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

@epicfaace For now, the least disruptive change was to make the modification here. Ideally, there wouldn't be duplication. Would you like to open an issue suggesting the above.

blurb
python-docs-theme
1 change: 1 addition & 0 deletions Doc/runtime.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.7
Copy link
Member

Choose a reason for hiding this comment

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

Could this be specified in netlify.toml too instead of a special-purpose file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

4 changes: 4 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[build]
base = "Doc/"
command = "make html"
publish = "Doc/build/html"