spl0k / supysonic

Supysonic is a Python implementation of the Subsonic server API.
https://supysonic.readthedocs.io
GNU Affero General Public License v3.0
264 stars 58 forks source link

Include man pages in setup.py #215

Closed Whisprin closed 2 years ago

Whisprin commented 3 years ago

After generating the man pages with make man from docs folder this change includes them in the Python package, making it easier to package supysonic

codecov[bot] commented 3 years ago

Codecov Report

Merging #215 (47bb259) into master (be88f5f) will decrease coverage by 0.05%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #215      +/-   ##
==========================================
- Coverage   88.56%   88.50%   -0.06%     
==========================================
  Files          35       35              
  Lines        3367     3367              
==========================================
- Hits         2982     2980       -2     
- Misses        385      387       +2     
Impacted Files Coverage Δ
supysonic/covers.py 80.39% <0.00%> (-3.93%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update be88f5f...47bb259. Read the comment docs.

spl0k commented 3 years ago

As much as I'd like the man pages to be installed with the application, this change references non-existent files. It requires the man pages to be generated beforehand. It would be best if they were generated during the install/packaging procedure.

As a side note: you're mentioning make man, which uses Sphinx to generate them. They are actually written to be generated with rst2man. These two methods give different results.

Whisprin commented 3 years ago

Oh, I see that the two methods give different results

Would you be okay with running rst2man in a custom install script from setup.py install? Similar to pycparser

spl0k commented 3 years ago

That's totally fine by me 👍