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

Examples folder outside of docs/ #92

Merged
merged 8 commits into from
Mar 15, 2024
Merged

Examples folder outside of docs/ #92

merged 8 commits into from
Mar 15, 2024

Conversation

Louis-Pujol
Copy link
Contributor

@Louis-Pujol Louis-Pujol commented Dec 21, 2023

This Pull request fixes #54

Examples folder could not be located outside of documentation folder. This was due to the use of the function PurePath.relative_to from the pathlib library : by default relative_to explores subpaths of the requested path. A solution is to use os.path.relpath, which is able to find paths starting with ../

In this PR, the aforementioned modification is done in plugin.py and the examples/ folder is moved outside of docs/ to illustrate this possibility.

  • I completed the issue numbers (#xx) in the sentence above. The word "fixes" should remain in front of each issue
  • My PR is tagged as draft when I'm still working on it, and I remove the draft flag when it is ready for review.
  • I added one or several changelog.md entries in the appropriate "in progress" section (not the last release one)

@smarie
Copy link
Owner

smarie commented Jan 16, 2024

Hi @Louis-Pujol , now that 0.10.0 is out you can probably update to latest HEAD. We'll try to integrate this in next release

@Louis-Pujol
Copy link
Contributor Author

Hi @smarie ! Sure, I think this is fine now. Tell me if it is not the case.

@smarie smarie merged commit b1125b7 into smarie:main Mar 15, 2024
13 checks passed
@smarie
Copy link
Owner

smarie commented Mar 15, 2024

Thanks @Louis-Pujol !

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.

Error when examples source dir is located outside docs dir
2 participants