bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

LaTeX Support #64

Open Jitsusama opened 7 years ago

Jitsusama commented 7 years ago

Hello, I was just wondering if there were any plans to support building LaTeX documentation with this extension? I write a lot of docs that are consumed both as HTML and PDF. I'm excited about the possibilities of this extension, but I'm not sure how I can use it if it can't support both output formats.

bitprophet commented 7 years ago

I'm afraid I don't have a PDF/LaTeX use case, so I've never tried!

But I don't see why there'd be any specific problem supporting alternative outputs as long as one found useful analogues to the HTML-isms currently in place (e.g. the use of CSS + classes to colorize the issue types, that sort of thing).

So, this falls firmly in the camp of "I don't have time to try it myself but I'd accept PRs that are proven not to break the HTML building use case" :)

Jitsusama commented 7 years ago

Thanks for the reply. The use case I'm thinking about is for keeping track of changes in company process documentation, so that upon a new update, someone used to the process can easily identify what areas they need to reivew because of changes introduced.

I'm in the middle of a few projects right now, but I will hopefully get around to digging into your code, keeping your comments in mind, to see if I can find a good way to handle both scenarios. I am worried that there would be no way to handle the CSS portion, but classes could probably be tied into LaTeX markup, so maybe in the worst case it would just involve recreating the CSS effects through some other means.

bitprophet commented 7 years ago

Yea, exactly. And it's not like those are 100% necessary bits of the output, either, especially if the target format is less friendly to arbitrary colorization of text, etc. So if the Sphinx LaTeX builder can be told to ignore that angle that's probably fine.