Documentation Update #449
Merged
Documentation Update #449
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
sushantmimani
changed the title
sushantmimani
force-pushed
the
doc-updates
branch
6 times, most recently
from
2671349
to
8e46de9
Compare
This is really messed up, but seems to work reliably now with local invocations of `poetry run tox -e docs` where before it mostly failed. As usual, I don't understand the situations under where it was able to work before. We'll see if the CI tests actually succeed once I push this... * `Makefile` fixes Extensive debugging suggested two related failure modes, where the `sphinx-build` script could not be located or when executed it failed to load modules. Investigation revealed that the "here" lines at the top of `sphinx-build` and friends used relative paths (`#!.tox/docs/bin/python`), and it appeared this was invoked in contexts where this path was not resolvable. Tracing the actual chain of control from `poetry` to `tox` back to `poetry` to `make` makes it difficult to understand what is actually going on. In any event, the fix incorporated here works around the problem by locating the absolute location of `sphinx-build` and then invoking it using `python /real/location/of/sphinx-build`, which causes the problematic relative reference to be ignored because the python interpreter is located using the scoping rules provided by `poetry`. I believe this was the critical fix of everything incorporated here. * `pyproject.toml` editorial fixes These are nits, cleaning up spacing and unnecessary quoting, and have no functional impact. * `tox.ini` fixes This probably isn't important, but I noted `make` wasn't getting invoked via `poetry run` like everything else, so I fixed it.
Use explicit dict instead of casting literal input
rbailey-godaddy
approved these changes
Mar 1, 2023
This reverts commit 740efe5. The cache does not appear to be at fault; let's turn it back on.
emayuri-godaddy
approved these changes
Mar 1, 2023
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.
To help us get this pull request reviewed and merged quickly, please be sure to include the following items:
PR Type
What kind of change does this PR introduce?
Backward Compatibility
Is this change backward compatible with the most recently released version? Does it introduce changes which might change the user experience in any way? Does it alter the API in any way?
Issue Linking
Fixes #419
Fixes #417