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

Convert YAML file paths to abspath #10

Merged
merged 3 commits into from
Apr 7, 2022
Merged

Convert YAML file paths to abspath #10

merged 3 commits into from
Apr 7, 2022

Conversation

ewu63
Copy link
Collaborator

@ewu63 ewu63 commented Apr 7, 2022

Purpose

In order to support out-of-source builds (say via VS code extensions), I have converged the input filepath for the YAML options to use abspath, by fetching the source RST file that called the extension via self.state.document.attributes["source"]. This does mean however that the specified file path should be relative to the RST file itself, rather than the root doc directory where conf.py is stored (i.e. the directory you call sphinx from). The only package where this affects things should be pyOptSparse, and I will push a fix for that soon.

Expected time until merged

ASAP

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Tested on ADflow and pyOptSparse.

Checklist

  • I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@ewu63 ewu63 merged commit 68b971b into main Apr 7, 2022
@ewu63 ewu63 deleted the add-abs-path branch April 7, 2022 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant