AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Update API Docs Sphinx Theme

Abierto
#1,872 3 comentarios 0 reacciones 1 asignado Reclamado por @pmady Ver en GitHub
Documentation
Lenguaje dominante
C++
Estrellas
2.1k
Forks
503
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

As discussed in the TSC already, our present theme used in the API documentation is [Press Theme](https://github.com/schettino72/sphinx_press_theme), and it has unfortunately been marked as looking for a new maintainer. I'm sure someone will take up that request, but it won't be us.

Given the slightly uncertain future of the theme, and some visual oddities it can produce, its a good opportunity to revamp the theme to something like [Furo](https://github.com/pradyunsg/furo) which keeps a clean and modern aesthetic with much more community support for the project its self. We've also seen that fellow ASWF/O*IO project OpenImageIO has adopted it themselves.

In theory its a single line change in the Sphinx configuration, so may be a good first issue, but its not immediately clear if it will require larger changes to maintain readability across the docs.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.