Fix publishing documentation #2384
Open
+36
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Avasam
commented
Oct 6, 2024
| 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.
If you still want this to be runnable w/o the python script, I think this should work to add a default executable location:
Suggested change
| HHC = hhc | |
| HHC = hhc | |
| # PYTHON is set in make.py, defaulting to the one found on PATH | |
| PYTHON = python |
|
Ah, another catch-22. |
Avasam
force-pushed
the
Fix-publishing-documentation
branch
from
6ee1a17
to
63f730c
Compare
…ublishing-documentation
…sam/pywin32 into Fix-publishing-documentation
Avasam
commented
Oct 14, 2024
Comment on lines
+46
to
+52
| # 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.
If we merged both workflows, we could push these as artifacts, then no need to download from PyPI
Avasam
commented
Oct 14, 2024
Comment on lines
+12
to
+14
| pull_request: # Temporary just for test | ||
| branches: | ||
| - main |
There was a problem hiding this comment.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the help files aren't shipped with the wheel in 307, the
docsworkflow 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:
docsworkflow (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