AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Update API Docs Sphinx Theme

Aperta
#1,872 3 commenti 0 reazioni 1 assegnatario Rivendicata da @pmady Vedi su GitHub
Documentation
Lingua principale
C++
Stelle
2.1k
Fork
503
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.