Opened 3 months ago

Last modified 2 months ago

#2311 new task

Update Sphinx presentation plugin

Reported by: sethg Owned by: osgeolive@…
Priority: normal Milestone:
Component: Documentation Keywords:
Cc: osgeolive@…

Description

Currently the OSGeoLive docs generate a presentation based on revealJS using the plugin sphinxjp.themes.revealjs - https://github.com/tell-k/sphinxjp.themes.revealjs

This plugin has not been updated for a couple of years and only works on sphinx==1.6.5.

A newer plugin which should also generate a presentation can be found at https://github.com/attakei/sphinx-revealjs and works with Sphinx > 3.0.0. Updating OSGeoLive-docs to use this plugin will allow using more recent versions of Sphinx.

Change history (3)

comment:1 Changed 3 months ago by kalxas

Cc: osgeolive@… added

comment:2 Changed 3 months ago by kalxas

Ubuntu Focal does not include sphinx 3.x so this would break our deb builds.

Please postpone for Ubuntu 22.04

comment:3 Changed 2 months ago by sethg

Postponing for a future release sounds good. The whole presentation would need to be rewritten to use the newer plugin. Docs are at https://sphinx-revealjs.readthedocs.io/en/latest/

The alternative is to take on the update of the existing library - which seems to already have been done by OSGeoLive contributors in 2018: https://github.com/tell-k/sphinxjp.themes.revealjs/pull/9

Note: See TracTickets for help on using tickets.