-
Notifications
You must be signed in to change notification settings - Fork 804
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
Fix publishing documentation #2384
Conversation
ADDOC = /RD "/O$(GENDIR)\$(TARGET).DOC" /D "doc_header=$(DOCHDR)" | ||
ADTAB = 8 | ||
HC = hcw /a /c /e | ||
HHC = hhc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you still want this to be runnable w/o the python script, I think this should work to add a default executable location:
HHC = hhc | |
HHC = hhc | |
# PYTHON is set in make.py, defaulting to the one found on PATH | |
PYTHON = python |
Ah, another catch-22. |
6ee1a17
to
63f730c
Compare
…ublishing-documentation
…sam/pywin32 into Fix-publishing-documentation
# This needs to happen *after* installing pywin32 since | ||
# AutoDuck/py2d.py currently relies on runtime imports for introspection | ||
# This isn't included in the wheel (TODO: could we?) | ||
# and only servces as a PR test for the docs.yaml workflow | ||
- name: Generate PyWin32.chm help file | ||
run: python AutoDuck/make.py | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we merged both workflows, we could push these as artifacts, then no need to download from PyPI
pull_request: # Temporary just for test | ||
branches: | ||
- main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this for the sake of testing in my PR, but if we keep this we wouldn't need to add a test in .github/workflows/main.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay, this is great, thanks!
@@ -43,6 +43,13 @@ jobs: | |||
run: | | |||
python setup.py install --user | |||
|
|||
# This needs to happen *after* installing pywin32 since | |||
# AutoDuck/py2d.py currently relies on runtime imports for introspection | |||
# This isn't included in the wheel (TODO: could we?) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: could we?
Open question on setuptools discussion: pypa/setuptools#4685
Since the help files aren't shipped with the wheel in 307, the
docs
workflow fails.Given the catch-22 nature of generating docs at the moment, and not wanting to create extra builds when not needed. I kept the PyPI download. But regerenate a .chm from source. (the help file generation honestly isn't that long anyway).
I also added doc generation as a CI test to sanity test that a PR won't break the docs publishing after a tag is created.
This PR makes the following changes:
docs
workflow (also done in Bump GitHub actions and checkers #2376)There are no technical reasons preventing us from still shipping the help files (
PyWin32.chm
), other than maybe their size (see #1380 (comment)). If it's a long-term choice, then let's also remove the dead setup code to register them. (we could ship a web link file instead) Otherwise I can add it back to the wheel as part of the automated process. Either way that'll be a different PR.This incidentally works towards #394