[GRASS-git] [OSGeo/grass] 0b25cf: docs: Generate libpython API docs only under the g...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 0b25cf0163752bd655dc78422ff5de047d4620ba
      https://github.com/OSGeo/grass/commit/0b25cf0163752bd655dc78422ff5de047d4620ba
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2026-07-17 (Fri, 17 Jul 2026)

  Changed paths:
    M .gitignore
    M doc/examples/notebooks/parallelization_tutorial.ipynb
    M doc/grass_projects.md
    M doc/python_intro.md
    M python/grass/docs/Makefile
    M python/grass/docs/conf.py
    M python/grass/docs/src/gunittest_testing.rst
    M python/grass/docs/src/index.rst
    M python/grass/docs/src/pygrass_gis.rst
    M python/grass/docs/src/pygrass_index.rst
    M python/grass/docs/src/pygrass_messages.rst
    M python/grass/docs/src/pygrass_modules.rst
    M python/grass/docs/src/pygrass_raster.rst
    M python/grass/docs/src/pygrass_vector.rst
    M python/grass/docs/src/script_intro.rst
    M python/grass/docs/src/temporal_framework.rst

  Log Message:
  -----------
  docs: Generate libpython API docs only under the grass namespace (#7740)

The Sphinx build of the Python library documented every subpackage
twice: once under a stripped namespace (pygrass, script, temporal, ...)
and once under the full, preferred one (grass.pygrass, grass.script,
...). Keep only the grass.* pages.

Drop the seven per-subpackage sphinx-apidoc runs and the sys.path
entries in conf.py that made the modules importable under their stripped
names, and point the handwritten pages, the theme navigation and the
links in doc/ at the grass.* pages and modules.

This removes 22 of the 42 Sphinx warnings. All ten "more than one target
found for cross-reference" warnings (Table, GrassTestFilesMultiReporter)
are gone, since they were caused purely by the duplicate generation, as
are the docstring warnings which were reported once per spelling.

The three remaining "duplicate object description" warnings (Module,
MultiModule, ParallelModuleQueue) are not caused by the stripped
namespace: grass.pygrass.modules re-exports these classes, so autodoc
documents them both on the package page and on the page of the module
defining them. They are left for a separate change.

This change was prepared with the assistance of Claude Code.



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications