reuse-tool icon indicating copy to clipboard operation
reuse-tool copied to clipboard

strange renaming of filenames

Open jonasstein opened this issue 2 years ago • 1 comments

While preparing a package for Gentoo building of the docs failed we found a strange change of filenames. We fixed it with a dirty patch and everything builds again. https://github.com/gentoo/gentoo/pull/33895/files#diff-69830a6b290a88118491417c503dae61d52afec497d4e0eb3055b1c54d9209d6 Also I think the files should not change names.

jonasstein avatar Nov 19 '23 15:11 jonasstein

I just had a look at this.

The reason the files README.md etc are copied to docs/ as part of the Sphinx compilation is because—if these files were symlinks instead—they would not be included in the sdist as such.

The reason they are relative links (../README.md) is because you're supposed to run make html inside of the docs/ directory.

The reason the files 'change names' is arbitrary. It affects the URL slug.

There is a way to make your patch unnecessary by making the paths relative to the value of __file__, which is an absolute path to docs/conf.py. PR welcome.

carmenbianca avatar Apr 27 '24 20:04 carmenbianca