Pourquoi Sphinx générer JSON?
-
20-09-2019 - |
Question
Je remarque que Sphinx a la capacité de produire de la documentation en JSON. Ce que ces fichiers sont utilisés pour?
La solution
les docs disent, il est
pour l'utilisation d'une application web (ou outil de post-traitement personnalisé) que ne pas utiliser la norme HTML modèles.
JSON est un bon moyen simple pour l'échange de données langage agnostique, donc, pourquoi pas -?)
Autres conseils
Je suppose que vous parlez du SerializingHTMLBuilder , dans ce cas, je pense que la réponse est peut-être qu'il n'y a pas nécessairement un but spécifique à l'esprit. Plutôt beaucoup de choses fournissent des routines de conversion de différents types avec « charges / décharges » convention API et le module json
(connu sous le nom simplejson
avant qu'il ne soit apporté bibliothèque standard 2.6) est un des nombreux ces paquets.
On peut supposer que certaines personnes préféreraient travailler avec des données au format JSON pour leurs propres fins. Si je devais en train de construire une sorte de système de documentation Javascripty dynamique, je pouvais imaginer choisir d'utiliser JSON comme le moyen d'obtenir de la documentation du back-end vers le client dans un format facile à gérer, si pour une raison quelconque HTML ou XML ne l'ont pas sembler comme la meilleure option.