Skip to content

Enlazar la página principal (GitHub Pages) con la documentación de la API en ReadTheDocs #42

Description

@mgraffg

Contexto

Parte del issue #34 (Página web). El requisito exacto, tal como está escrito ahí, es:

La página principal https://ingeotec.github.io/CompStats y la página que documenta la API de la librería que esta en readthedocs.

Es decir: el sitio principal (GitHub Pages, construido con Quarto) y la documentación de la API (Sphinx, publicada en ReadTheDocs) son dos sitios distintos que deben quedar enlazados entre sí — este issue es el que cubre específicamente esa mención de ReadTheDocs dentro de #34.

Con la migración del sitio a un proyecto Quarto de tipo website (ver #43, estructura tipo https://ingeotec.github.io/LegalIA/), el enlace ya no se agrega en un dashboard de una sola página sino en el navbar/page-footer de _quarto.yml. Actualmente no hay ningún enlace cruzado entre ambos sitios:

Qué hacer

  • En quarto/_quarto.yml (definido en Crear la plantilla del sitio en Quarto (estructura tipo LegalIA) y la página de Introducción #43), agregar en website.navbar (o website.page-footer) un enlace hacia la documentación de la API en ReadTheDocs.
  • En la documentación de Sphinx (docs/source/conf.py o en el index/template usado), agregar un enlace de vuelta hacia la página principal https://ingeotec.github.io/CompStats.
  • Confirmar la URL exacta de ReadTheDocs del proyecto antes de enlazarla (verificar en la configuración del proyecto en readthedocs.org o en un README/badge existente).

Referencia

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions