Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for previous releases #163

Closed
kastman opened this issue Mar 28, 2018 · 5 comments
Closed

Add docs for previous releases #163

kastman opened this issue Mar 28, 2018 · 5 comments

Comments

@kastman
Copy link

kastman commented Mar 28, 2018

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
Copy link
Author

kastman commented Mar 30, 2018

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,

@kastman kastman closed this as completed Mar 30, 2018
@mwaskom
Copy link
Owner

mwaskom commented Mar 30, 2018

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
Copy link
Owner

mwaskom commented Mar 30, 2018

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

@kastman
Copy link
Author

kastman commented Mar 30, 2018

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
Copy link
Owner

mwaskom commented May 13, 2019

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/

mwaskom added a commit that referenced this issue May 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants