canonical / sphinx-docs-starter-pack

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

Add tests for the starter pack #261

Closed ru-fu closed 1 month ago

ru-fu commented 1 month ago

This PR adds a general test for the init script, running it both with "." and with "docs" as installation folder and making sure that both the build and the checks run without errors.

In addition, it adds some test files that we can use to test the starter pack functionality. For now, I've only included related links and Discourse links, mainly to show how these tests can be implemented.

ru-fu commented 1 month ago

Expected to fail now since it's pulling the init script from use-canonical-sphinx-extensions and not this branch - should work again after merging.