Autodoc

[jeanjacquemier]

Add the documentation with Sphinx and the corresponding mechanisms
- Add a logo to the README
- Add clp_covariance and clp_firecrown confirguration options
- Add an overview
- Add an installation doc:
- Add doc generation with CI
- Use github Pages withgithub actions to publish the docs
- add deployment on autodoc branch before merging
- Add some github badges
- Add LSST DESC software dependencie to doc

[Copilot]

Copilot review overview

🟡 Changes recommended

The documentation contains invalid configuration guidance, lacks functional autodoc, and includes build and deployment defects.

Review effort: Balanced
Findings: 1 · 6 · 6

Open (13)

• Keep checked-in documentation out of make clean · New
• Restrict production publishing to the main branch · New
• Use O instead of zero for Make options · New
• Enable autodoc extensions and add API documentation · New
• Remove unsupported cosmo configuration from CLPCovariance · New
• Document the correct default HMF model · New
• Replace copied CLPCovariance options with Firecrown options · New
• Use descriptive alt text for the logo · New
• Correct the spelling of publicly · New
• Reference merge_data_covariance for mixed covariance blocks · New
• Remove Markdown fences from the reStructuredText literal block · New
• Remove the literal Markdown fence from the test command · New
• Fix line wrapping and opening article in overview · New

What changed in this PR

Introduces a Sphinx documentation site, configuration guides, and automated validation/deployment.

Changes:

• Adds overview, installation, covariance, and Firecrown documentation.
• Adds Sphinx configuration and dependencies.
• Adds documentation CI, GitHub Pages deployment, and README branding.

File	Description
README.md	Adds the CLPipe logo.
docs/​source/​overview.rst	Adds the project overview.
docs/​source/​installation.rst	Adds installation and testing instructions.
docs/​source/​clp_firecrown.rst	Documents Firecrown configuration.
docs/​source/​clp_covariance.rst	Documents covariance configuration.
docs/​requirements.txt	Declares documentation dependencies.
docs/​Makefile	Adds Sphinx build targets.
docs/​index.rst	Defines documentation navigation.
docs/​conf.py	Configures Sphinx and its theme.
.gitignore	Ignores generated documentation.
.github/​workflows/​docs.yml	Builds and deploys documentation.
.github/​workflows/​ci.yml	Adds documentation validation.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[jeanjacquemier]

@eduardojsbarroso ?

[coveralls]

Coverage Report for CI Build 37614240398

Warning

No base build found for commit 3a6cd70 on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 42.255%

Details

• Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →

---

Coverage Stats

Relevant Lines:	1020
Covered Lines:	431
Line Coverage:	42.25%
Coverage Strength:	0.85 hits per line

---

💛 - Coveralls

[codecov-commenter]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️