search

VDBWRAIR / ngs_mapper

Genome Mapping Pipeline
GNU General Public License v2.0
8 stars 10 forks source link

Make correct docs easy to find #222

Closed averagehat closed 8 years ago

averagehat commented 8 years ago
necrolyte2 commented 8 years ago

I'm not sure including instructions on how to build the docs is necessary now that we have readthedocs available. I feel like only devs would be the ones building the docs and they shouldn't need docs to tell them how to use sphinx right?

averagehat commented 8 years ago

The reason is that someone may be using an older version of ngs_mapper. Unfortunately we can only host docs for the latest version on readthedocs. But if they have the old version and they want the matching docs, their only option to get accurate docs is to build it locally.

Maybe there's a better way?

necrolyte2 commented 8 years ago

I think since the project was not open to public we don't have to worry about older versions right?

On Tue, Mar 29, 2016, 9:03 PM Mike Panciera notifications@github.com wrote:

The reason is that someone may be using an older version of ngs_mapper. Unfortunately we can only host docs for the latest version on readthedocs. But if they have the old version and they want the matching docs, their only option to get accurate docs is to build it locally.

Maybe there's a better way?

— You are receiving this because you commented.

Reply to this email directly or view it on GitHub https://github.com/VDBWRAIR/ngs_mapper/issues/222#issuecomment-202908228

averagehat commented 8 years ago

Right but if we do update it in a way that changes the usage . . .

necrolyte2 commented 8 years ago

Ahh, ok I see what you mean now. So if you look at bio bits somehow we managed to configure it to build every release so users can click on any release. Was thinking this project did that too. We should make it do that

On Tue, Mar 29, 2016, 9:13 PM Mike Panciera notifications@github.com wrote:

Right but if we do update it in a way that changes the usage . . .

— You are receiving this because you commented.

Reply to this email directly or view it on GitHub https://github.com/VDBWRAIR/ngs_mapper/issues/222#issuecomment-202912338

necrolyte2 commented 8 years ago

I don't remember ever enabling 'build every version/release' on our other project, but it seems to do it automatically. I've gone through and told RTD to build a bunch of previous versions so they will now show on the site

averagehat commented 8 years ago

fixed in 61cc534 and eaacb53