Optimiza tu documentación para que los motores de búsqueda (y otros usuarios) la encuentren#
Si estás interesado en que más gente encuentre tu paquete, puede que quieras añadir algunas extensiones de Sphinx (y configuraciones de tema) que ayudarán a los motores de búsqueda como Google a encontrar tu documentación.
Google Analytics#
Importante
Google Analytics no cumple con el Reglamento General de Protección de Datos (RGPD) europeo. Aunque este reglamento tiene muchos componentes, uno de los elementos centrales es que tienes que informar a los usuarios en tu sitio que estás recopilando datos y que deben dar su consentimiento. Si bien es posible añadir infraestructura en torno a Google Analytics para que se acerque al cumplimiento de las regulaciones del RGPD, la comunidad se está alejando lentamente de Google utilizando herramientas abiertas como Plausible, Cloudflare Web Analytics y Matomo para el análisis web.
pyOpenSci está investigando actualmente opciones gratuitas para desarrolladores de código abierto.
Algunos de los temas de Sphinx como pydata-sphinx-theme y sphinx-book-theme tienen soporte integrado para Google Analytics. Sin embargo, si el tema que elegiste no ofrece soporte para Google Analytics, puedes usar la extensión sphinxcontrib-gtagjs. Esta extensión añadirá una etiqueta de sitio de Google Analytics a cada página de tu documentación.
sphinx-sitemap para la optimización de motores de búsqueda#
Aunque estamos tratando de alejarnos de Google Analytics debido a problemas de cumplimiento y privacidad, la optimización para motores de búsqueda sigue siendo importante. Google es el motor de búsqueda más popular. ¡Y si tu documentación está optimizada para búsquedas, es más probable que los usuarios encuentren tu paquete!
Si estás interesado en optimizar tu documentación para motores de búsqueda como Google, querrás un archivo sitemap.xml. Puedes enviar este mapa del sitio a Google y este indexará todo tu sitio. Con el tiempo, esto puede hacer que el contenido de tu sitio sea más visible para otros cuando realicen búsquedas.
Esta extensión es ligera.
sphinxext.opengraph#
OpenGraph is an extension that allows you to add metadata to your documentation content pages. The OpenGraph protocol allows other websites to provide a useful preview of the content on your page when shared. This is important for when the pages in your documentation are shared on social media and even for shares on collaboration platforms like Slack and Discourse.