Taking down older versions of our docs

[Aaron Meurer]

We currently host a lot of old versions of our docs at docs.sympy.org. I don't really like this though, because too many people end up at old versions of the docs. For example, if you google "sympy matrices" you end up at the 0.7.2 docs. 

Should we remove the old versions of the docs, possibly adding redirects to the latest pages so that links don't break?

If not, does anyone know how to automatically add a "These docs are for an old version, find the latest version here" banner to the top of every old docs page?

Aaron Meurer

[Jason Moore]

It should be fairly easy to have an if statement in the jinja templates that shows a warning and link to the newer docs only if the docs aren't the latest. I think we should leave old docs available and just add the warning. readthedocs does this automatically for you, I believe.

Jason
moorepants.info
+01 530-601-9791

--
You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To post to this group, send email to sy...@googlegroups.com.
Visit this group at http://groups.google.com/group/sympy.
To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6KKgFrYzsv_c1mCAz7HSkm6hgpEPwvkvTXTpoSH9-SYUw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[Aaron Meurer]

The docs aren't using jinja. They're just html generated by Sphinx, with some patches to support cross-linking (see https://github.com/sympy/sympy_doc/blob/gh-pages/generate_indexes.py). If you know how to make it use Jinja and that would make things easier, then definitely go for it.

Aaron Meurer

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1AgE_6sP0Bkp0ACJkxYwt%2BB_YvCNGo6qh_TDLRfKozh3Vw%40mail.gmail.com.

[Ondřej Čertík]

On Tue, Apr 15, 2014 at 2:55 PM, Aaron Meurer <asme...@gmail.com> wrote:
> We currently host a lot of old versions of our docs at docs.sympy.org. I
> don't really like this though, because too many people end up at old
> versions of the docs. For example, if you google "sympy matrices" you end up
> at the 0.7.2 docs.

I fell into this trap myself couple times. A big fat warning on top
should fix this though.

Ondrej

>
> Should we remove the old versions of the docs, possibly adding redirects to
> the latest pages so that links don't break?
>
> If not, does anyone know how to automatically add a "These docs are for an
> old version, find the latest version here" banner to the top of every old
> docs page?
>
> Aaron Meurer
>

[F. B.]

By the way, the dev docs are stuck to version 0.7.3

http://docs.sympy.org/dev/

[Jason Moore]

Sphinx allows you to introduce jinja templates to override their defaults. I think all you have to do is copy the correct template that Sphinx is already using, modify it to your liking, and drop it in the _templates directory:

http://sphinx-doc.org/templating.html

Jason
moorepants.info
+01 530-601-9791

On Wed, Apr 16, 2014 at 3:13 AM, F. B. <franz....@gmail.com> wrote:

By the way, the dev docs are stuck to version 0.7.3

http://docs.sympy.org/dev/

--

You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To post to this group, send email to sy...@googlegroups.com.
Visit this group at http://groups.google.com/group/sympy.

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/d50ec2c3-0bfb-4391-93a2-95c76466fd1c%40googlegroups.com.

[Jason Moore]

I started implementing something for this, but I don't know what to do about the fact that the patch I'm creating will only work for this version of sympy and future versions. If I git checkout an older version of sympy and build the docs, it will of course not have my patch. Any ideas on how we could use the patch from a current version of sympy when building previous doc versions?

Jason
moorepants.info
+01 530-601-9791

[Jason Moore]

I guess this doesn't matter. We will just have to generate the old docs with the new warning manually for each release.

Jason
moorepants.info
+01 530-601-9791

[Aaron Meurer]

We can manually add it to the old docs I suppose. 

Aaron Meurer

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAP7f1Ag5Ta8EGNi9-pUiQcvA7BTn6WxDuzG2hSvObiMea8%3DjSw%40mail.gmail.com.

[Aaron Meurer]

The dev docs are a separate issue. The problem there is that they are only updated when someone builds them and updates the docs in the repo. It would be nice if we had a bot that did this automatically.

Aaron Meurer

On Wed, Apr 16, 2014 at 2:13 AM, F. B. <franz....@gmail.com> wrote:

By the way, the dev docs are stuck to version 0.7.3

http://docs.sympy.org/dev/

--

You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To post to this group, send email to sy...@googlegroups.com.
Visit this group at http://groups.google.com/group/sympy.

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/d50ec2c3-0bfb-4391-93a2-95c76466fd1c%40googlegroups.com.

[Aaron Meurer]

Until then, anyone can update the dev docs. Just send a pull request to https://github.com/sympy/sympy_doc, or push it directly if you have access. There are instructions in the README on how to do it (it's really simple).

Aaron Meurer

[Sudhanshu Mishra]

Hi all

I've sent a PR to update the dev docs.

With Regards

Sudhanshu Mishra