search

BoPeng / simuPOP

A general-purpose forward-time population genetics simulation environment.
http://bopeng.github.io/simuPOP/
GNU General Public License v2.0
29 stars 12 forks source link

Cookbook links from simuPOP homepage, User Guide and Reference Manual are broken #120

Closed lfmcmillan closed 2 weeks ago

lfmcmillan commented 2 weeks ago

The homepage (https://bopeng.github.io/simuPOP/) has a broken link in the left-hand menu to the cookbook: https://github.com/BoPeng/simuPOP/cookbook

The Reference Manual has the same broken link in the left-hand menu to the cookbook

The "What is simuPOP?" page of the User Guide (http://bopeng.github.io/simuPOP/userGuide_ch2_sec1.html) also provides the same broken link

The readthedocs version of the User Guide provides a broken link to a sourceforge version of the cookbook: http://simupop.sourceforge.net/cookbook (see near the bottom of https://simupop.readthedocs.io/en/latest/userGuide_ch2_sec1.html)

If you search for "simuPOP cookbook" on google, none of the first 10 links are direct links to the cookbook. One or two of them are links to the Bioinformatics with Python Cookbook, but only the first and second editions of that book even mention simuPOP, and the third edition cut out all the simuPOP bits.

If the cookbook has been relocated then please fix the links, thanks very much.

lfmcmillan commented 2 weeks ago

The figure on the "An overview of simuPOP" page (http://bopeng.github.io/simuPOP/userGuide_ch2_sec2.html) is also missing

BoPeng commented 2 weeks ago

Yes, cookbook should refer to https://github.com/BoPeng/simuPOP-examples, especially its example directory, and the sourceforge links should have been gone long ago. The figure should point to https://github.com/BoPeng/simuPOP/blob/master/doc/figures/evolve.png

Do you have time to work on a PR?

lfmcmillan commented 2 weeks ago

Yes, I think so. Do you want it to still be referred to as the Cookbook, or the Examples (i.e. links changed or also change text references)?

On Tue, 27 Aug 2024 at 16:45, Bo @.***> wrote:

Yes, cookbook should refer to https://github.com/BoPeng/simuPOP-examples, especially its example directory, and the sourceforge links should have been gone long ago. The figure should point to https://github.com/BoPeng/simuPOP/blob/master/doc/figures/evolve.png

Do you have time to work on a PR?

— Reply to this email directly, view it on GitHub https://github.com/BoPeng/simuPOP/issues/120#issuecomment-2312920348, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRIMMGZYCEGHFQTRNIPA7TZTSNIRAVCNFSM6AAAAABNGLVKH2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJSHEZDAMZUHA . You are receiving this because you authored the thread.Message ID: @.***>

BoPeng commented 2 weeks ago

Thanks! Just examples would do since they are not organized as a book (with topics and sections).

lfmcmillan commented 2 weeks ago

OK, I think I'm fixing the source files since I don't know how to rebuild the HTML files from the source.

On Tue, 27 Aug 2024 at 17:49, Bo @.***> wrote:

Thanks! Just examples would do since they are not organized as a book (with topics and sections).

— Reply to this email directly, view it on GitHub https://github.com/BoPeng/simuPOP/issues/120#issuecomment-2313063232, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRIMMAXWQ6M77KLFWDS6ULZTSU2TAVCNFSM6AAAAABNGLVKH2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJTGA3DGMRTGI . You are receiving this because you authored the thread.Message ID: @.***>