search

mwaskom / lyman

Data pipelines and analysis library for functional MRI
http://www.cns.nyu.edu/~mwaskom/software/lyman
BSD 3-Clause "New" or "Revised" License
54 stars 22 forks source link

Add docs for previous releases #163

Closed kastman closed 6 years ago

kastman commented 6 years ago

Is it possible to provide versioned docs for the older releases of lyman? I tried adding lyman to readthedocs myself, but the theme's package isn't included in requirements.txt and building subsequently fails. I could submit a PR including the theme on the 1.0 branch if you were interested.

At the very least, it would be helpful if you left the docs for 1.0 up somewhere. Is that possible or should I host it somewhere else? Thanks,

kastman commented 6 years ago

FYI I mirrored the 1.0.0 docs on my own local server so I could get to them easily. Good luck with the rewrite,

mwaskom commented 6 years ago

That makes sense. I was going to try to get to putting up a copy but have been busy. I'm not certain that readthedocs can handle the full build including capturing the command-line help.

mwaskom commented 6 years ago

It's weird that your build has the sidebar, that wasn't present on the original version.

kastman commented 6 years ago

No worries; just wanted to give you a heads up. _static/styles.css wasn't checked into the 1.0 branch so I stole it from 2.0.0dev which may explain the sidebar, or maybe it's just the latest sphinx_bootstrap_theme since that wasn't version-locked at all. There are small differences (e.g. <ul> bullets are visible), but that seems acceptable for the mirror.

RTD has a set number of sphinx builders that it uses for documentation, and I suspect you're right that the cmdline make dependency wouldn't be picked up. Maybe worth looking into, but probably not worth it for 1.0.

mwaskom commented 5 years ago

Just a heads up that I finally got around to doing this, and put them here: http://www.cns.nyu.edu/~mwaskom/software/lyman1.0/