search

KhronosGroup / KTX-Software

KTX (Khronos Texture) Library and Tools
Other
854 stars 226 forks source link

pyktx docs use of `_` prefix conflicts with GitHub Pages' Jekyll. #825

Closed MarkCallow closed 7 months ago

MarkCallow commented 8 months ago

Jekyll considers any files or directories whose names start with _ to be special resources and does not copy them to the final GitHub Pages site. This breaks the pyktx docs whose scripts, css and various other assets are stored in such directories. According to https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/ this can be avoided by creating a file called .nojekyll in the doc root. Need to either do this or get the pyktx doc generation to use different names.

MarkCallow commented 8 months ago

@ShukantPal when I wrote asking you if it is possible to generate the pyktx docs without underscore-prefixed names I couldn't think of a way to get Doxygen to add a specific named file to the output it generates. Indeed I have not been able to find a way. Instead I've added something to the build script in the CI .yml file to create .nojekyll. If it is easy to change the names in the Sphinx-generated pyktx docs I'd prefer that. If so, please make a PR with the necessary changes. Otherwise I'll use the CI script hack.

MarkCallow commented 7 months ago

@ShukantPal can you easily change the file name in the Sphinx-generated docs?