docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon OpenDroneMap

Documentation for master/releases

Open dakotabenjamin opened this issue 6 years ago • 5 comments

Is it possible to have a pulldown for different versions of the docs? Like for the latest, version 0.3, etc.

dakotabenjamin avatar Aug 29 '18 06:08 dakotabenjamin

Read the Docs supports multiple versions for things it hosts. Doesn't help ODM.

Found sphinxcontrib-versioning which is a Sphinx extension that allows building versioned docs when self-hosting. But it was last updated in 2016.

I can look around and see what might be possible. You would start doing releases on this repository to manage the versions? Or handle via branches? Or?

danbjoseph avatar Aug 29 '18 14:08 danbjoseph

We are already doing releases, currently at 0.3.1, with 0.4 coming in the next few days. This is done with the GitHub tagging system.

dakotabenjamin avatar Aug 29 '18 19:08 dakotabenjamin

Tags for versions of the docs? Or tags for ODM versions?

danbjoseph avatar Aug 29 '18 22:08 danbjoseph

ODM versions. I guess it would be difficult if the repository is different from the ODM code, right?

dakotabenjamin avatar Aug 30 '18 05:08 dakotabenjamin

Pretty sure you would need to tag the docs repository as well, to match whatever version of ODM code it's for.

danbjoseph avatar Aug 31 '18 18:08 danbjoseph