Julia: Documentation for old/unmaintained releases of julia

Created on 24 Jul 2017  路  8Comments  路  Source: JuliaLang/julia

Many google searches will often bring up the documentation for older releases of julia. When trying to search for e.g. "julia integer" or something similar the docs for v0.4 will be the first hit.

To prevent confusion I think it would be useful to either:

  • Provide an obvious warning somewhere on each page (ala scikit-learn) - stating that those docs are for an un-maintained version of julia
  • Automatically redirect (maybe with a notice saying "you have been redirected to the documentation for the latest stable version of julia - click here to see the docs for v0.x".

Happy to submit a PR if people agree.

doc

Most helpful comment

It should be possible to keep old versions of the documentation out of Google search results entirely (maybe via robot.txt or something?). That might be the best solution. I don't think we necessarily want to redirect people since there are probably people still stuck on e.g. 0.4 for whatever reason who still need access to the documentation.

All 8 comments

It should be possible to keep old versions of the documentation out of Google search results entirely (maybe via robot.txt or something?). That might be the best solution. I don't think we necessarily want to redirect people since there are probably people still stuck on e.g. 0.4 for whatever reason who still need access to the documentation.

It should be possible to keep old versions of the documentation out of Google search results entirely (maybe via robot.txt or something?). That might be the best solution.

What about googling for functions that have been deprecated and are not part of the current documentation?

Ah, a very good point. Perhaps a big warning at the top of the old page would be good then.

Sounds like a warning on old versions is the best way to go. Anyone got any smart ideas about how easiest to do that (not super familiar with Documenter)?

The documentation for versions of Julia prior to 0.6 didn't use Documenter. I'm not sure how those docs were generated.

It's via sphinx

https://github.com/JuliaLang/julia/blob/release-0.5/doc/Makefile#L69
this target can generate static html, and you will need a python virtualenv with sphinx installed

Please checkout this PR: #23043

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tkoolen picture tkoolen  路  3Comments

helgee picture helgee  路  3Comments

StefanKarpinski picture StefanKarpinski  路  3Comments

yurivish picture yurivish  路  3Comments

omus picture omus  路  3Comments