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

Documentation Update #449

Merged
merged 8 commits into from
Mar 1, 2023
Merged

Commits on Feb 28, 2023

  1. Configuration menu
    Copy the full SHA
    9b1bdf3 View commit details
    Browse the repository at this point in the history
  2. Address open issues

    sushantmimani committed Feb 28, 2023
    Configuration menu
    Copy the full SHA
    8e46de9 View commit details
    Browse the repository at this point in the history
  3. Try to fix CI failure

    sushantmimani committed Feb 28, 2023
    Configuration menu
    Copy the full SHA
    00c8e97 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    740efe5 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    83f90b0 View commit details
    Browse the repository at this point in the history

Commits on Mar 1, 2023

  1. (Maybe) fix docs generation

    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.
    rscottbailey committed Mar 1, 2023
    Configuration menu
    Copy the full SHA
    79769c4 View commit details
    Browse the repository at this point in the history
  2. Fix linter error

    Use explicit dict instead of casting literal input
    rscottbailey committed Mar 1, 2023
    Configuration menu
    Copy the full SHA
    b5a1a94 View commit details
    Browse the repository at this point in the history
  3. Revert "Remove cache. Maybe it is causing version conflict."

    This reverts commit 740efe5.
    
    The cache does not appear to be at fault; let's turn it back on.
    rscottbailey committed Mar 1, 2023
    Configuration menu
    Copy the full SHA
    fd3299d View commit details
    Browse the repository at this point in the history