canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 37 forks source link

init script: create link for .wokeignore #136

Closed ru-fu closed 10 months ago

ru-fu commented 10 months ago

When running woke locally, the .wokeignore file must be in the folder where you run it (for example, the docs folder). When runnin on GitHub, we run woke from the root folder though, and it cannot deal with a .wokeignore file in a subdirectory. Therefore, have the script create a symlink (unless there already is a .wokeignore file in the root folder).

pmatulis commented 10 months ago

And don't we need to make an analogous change in the manual steps?

ru-fu commented 10 months ago

Thanks for the review @pmatulis ! Updated now.