search

jgaeddert / liquid-dsp

digital signal processing library for software-defined radios
http://liquidsdr.org
MIT License
1.9k stars 443 forks source link

How to build the documentation? #55

Open novelistparty opened 8 years ago

novelistparty commented 8 years ago

Is it in a separate repo?

jgaeddert commented 8 years ago

The documentation is an ugly beast for sure. I maintain the documentation online here: http://liquidsdr.org/doc

Is there a specific reason you want to build the documentation yourself?

novelistparty commented 8 years ago

I am offline for long periods of time and I prefer docs that are synced with the source as opposed to me having to mirror the website and hope that it matches a specific release.

jgaeddert commented 8 years ago

I understand. I split the documentation off the main branch because building it involved installing a LOT of dependencies, and it was getting too complex for most people. Would a pre-compiled .pdf be sufficient?

novelistparty commented 8 years ago

I would prefer the html docs as they are easier to navigate because of their internal links. But if you had the internal links working well in the pdf, that would be fine.

Thanks.