Repository navigation

docs: bring the documentation in line with the code - #488

Merged

sameeul merged 23 commits into

PolusAI:mainfrom

darkclad:main-docs-update

Oct 22, 2026

Merged

docs: bring the documentation in line with the code#488
sameeul merged 23 commits into
PolusAI:mainfrom
darkclad:main-docs-update

Commits on Oct 15, 2026
- docs(build): build the site without the compiled extension and fail CI on warnings
  Demian Vladi
  committed
  48ab052
- docs(readme): slim the README and add the entry pages
  Demian Vladi
  committed
  ab8a89e
- docs(cli): generate the command-line reference and correct the usage pages
  Demian Vladi
  committed
  31633fe
- docs(io): describe the supported formats, the output and the shared conventions
  Demian Vladi
  committed
  3941234
- docs(scale): document large images, volumes and GPU acceleration
  Demian Vladi
  committed
  4e2bb64
- docs(guide): add IBSI mode, validation and troubleshooting pages
  Demian Vladi
  committed
  66df924
- docs(features): generate the feature list, the groups and the family indexes
  Demian Vladi
  committed
  8b95bf2
- test(docs): run every documentation example as part of the test suite
  Demian Vladi
  committed
  1ec703c
- docs(features): rewrite the 2D intensity, histogram and image quality pages
  Demian Vladi
  committed
  9d764c4
- docs(features): rewrite the 2D morphology, erosion, fractal and radial pages
  Demian Vladi
  committed
  bcc7334
- docs(features): rewrite the moments, Zernike and Gabor pages
  Demian Vladi
  committed
  a22308d
- docs(features): rewrite the GLCM, GLRLM and GLSZM pages
  Demian Vladi
  committed
  463a80b
- docs(features): rewrite the GLDM, GLDZM, NGLDM and NGTDM pages
  Demian Vladi
  committed
  ac1948d
- docs(features): add the 3D intensity, shape and texture pages
  Demian Vladi
  committed
  a23e988
- docs(api): rewrite the Python docstrings in numpydoc style and check them against the code
  Demian Vladi
  committed
  1ab5e04
- docs(devguide): rewrite the developer guide and correct the project notes
  Demian Vladi
  committed
  b141226
- test(docs): accept the platform-dependent results of two overflow examples
  Demian Vladi
  committed
  5384205
- test(docs): expect the unsigned wrap of the GLSZM overflow example on macOS
  Demian Vladi
  committed
  47c2036
Commits on Oct 16, 2026
- chore(docs): find CLI defaults by symbol and stop link checks blocking CI
  Demian Vladi
  committed
  8dfe1b0
- docs: correct the pages, scripts and registry rows named in review
  Demian Vladi
  committed
  26d3205
- docs: link the known defects to their issues
  Demian Vladi
  committed
  ff8f931
Commits on Oct 19, 2026
- docs: answer the second review of the pages, scripts and registry
  Demian Vladi
  committed
  c6f8475
Commits on Oct 20, 2026
- style(docs): put the 3D ball assert message on its own line
  Demian Vladi
  committed
  062fa01

Commits

Commits on Oct 15, 2026

Commits on Oct 16, 2026

Commits on Oct 19, 2026

Commits on Oct 20, 2026