search

domokane / FinancePy

A Python Finance Library that focuses on the pricing and risk-management of Financial Derivatives, including fixed-income, equity, FX and credit derivatives.
GNU General Public License v3.0
2.15k stars 321 forks source link

Re-generate manual when master is updated #181

Closed FergalOK closed 1 year ago

FergalOK commented 1 year ago

To prevent the manual from being out of date, it should be updated when master is changed.

An example of how pandas keeps their documentation up to date: https://github.com/pandas-dev/pandas/blob/main/.github/workflows/docbuild-and-upload.yml

We would want to do this, but to update FinancePyManual.pdf (instead of uploading to a website).

One way of doing this would be similar to this stackoverflow post

domokane commented 1 year ago

Thanks. But I just realised I need latex for it to work! Oops.

FergalOK commented 1 year ago

Why would that be a problem?

domokane commented 1 year ago

Can you install Miktex on GitHub servers ?

FergalOK commented 1 year ago

I don't see why not, you can run apt install just fine.

I've been struggling to actually get the script to work on my own computer though.

domokane commented 1 year ago

There were some issues that I fixed yesterday. Some of the new pushes by others included characters that were problematic such as "##" and "&" and urls. I removed these and pushed. It should work now.