search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
10 stars 30 forks source link

Add check for Sphinx build dependencies, consequently documenting them #247

Closed fnordahl closed 4 weeks ago

fnordahl commented 1 month ago

Please review/merge commit by commit.

Fixes #238

fnordahl commented 1 month ago

Happy to approve when comments are addressed.

I don't know why rustc would be a dependency, but I assume this is somewhat targeted for the risk 5 system that produced the original issue that prompted this addition. I see no reason to prevent this merge based on information I don't have - but am curious as to why this is a dep - and if this would support all the potential archs that may use this check.

There are multiple Python packages that require a Rust compiler to build from source on any architecture. The watchfiles dependency is one the direct ones, but there are most likely indirect ones as well: https://github.com/canonical/sphinx-docs-starter-pack/blob/a2c5c72312f6408f2d01986e70a6634d50b51fd0/.sphinx/build_requirements.py#L86

fnordahl commented 1 month ago

Spotted a typo in the description/commit message for the workflow file, so one more update coming.