canonical / sphinx-docs-starter-pack

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

Inconsistent help text of Makefile #164

Closed dviererbe closed 6 months ago

dviererbe commented 7 months ago

Current behavior

Expected Behavior

  1. make install and make help should show the same help information
  2. make help should show some supported targets (e.g. run, serve, woke, clean-doc)
  3. make help should not show unsupported targets (e.g. man, qthelp)

Nitpick/Polish: It somehow bugs me that nothing is happening (not even a warning) on a second invocation of the install target.

Reference

help target

https://github.com/canonical/sphinx-docs-starter-pack/blob/9bb5387e85e8c22d21a7525c186cb245bd1e2189/Makefile#L18-L20

source of the install target help text

https://github.com/canonical/sphinx-docs-starter-pack/blob/9bb5387e85e8c22d21a7525c186cb245bd1e2189/Makefile#L26-L49

pmatulis commented 6 months ago

Resolved by #181