Documentar cómo previsualizar el sitio Quarto y la documentación de docs/ desde develop

[mgraffg]

Purpose

Before merging develop into main, reviewers need a quick, self-contained way to check out
develop locally and preview both documentation sites:

• the Quarto site under quarto/
  (the project's main site, published to GitHub Pages), and
• the Sphinx API docs under docs/
  (published to ReadTheDocs).

This issue documents the commands to do that.

1. Clone the repository and check out develop

git clone https://github.com/INGEOTEC/CompStats.git
cd CompStats
git checkout develop

2. Install the package and its dependencies

pip install -e .
pip install -r requirements.txt

3. Preview the Quarto site (quarto/)

Requires Quarto to be installed locally.

cd quarto
quarto preview

quarto preview renders the site and opens it in the browser with live reload, so it is the
fastest way to review pages (index.ipynb, pages/sklearn_users.ipynb,
pages/competition_organizers.ipynb, pages/multiple_testing.ipynb) as they will appear once
published.

Alternatively, a static render (matching what CI publishes via
.github/workflows/publish.yml) can be produced without a live server:

cd quarto
quarto render

The output is written to quarto/_site/; open quarto/_site/index.html in a browser.

4. Build the Sphinx API documentation (docs/)

cd docs
make html

Open docs/build/html/index.html in a browser to review the rendered API reference.

Reviewer checklist

• Clone the repo and check out develop
• Install dependencies (pip install -e ., pip install -r requirements.txt)
• Preview the Quarto site (quarto preview from quarto/) and review each page
• Build and review the Sphinx docs (make html from docs/)
• Report any issues found here before this content is merged into main