[GRASS-git] [OSGeo/grass] 0cb81b: grass.jupyter: Generate API doc for Jupyter packag...

Vaclav Petras noreply at github.com
Tue Apr 12 13:56:53 PDT 2022


  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 0cb81b3547c5123233576c35bd3b2aec9eaf2765
      https://github.com/OSGeo/grass/commit/0cb81b3547c5123233576c35bd3b2aec9eaf2765
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2022-04-12 (Tue, 12 Apr 2022)

  Changed paths:
    M .github/workflows/pylint.yml
    M python/grass/docs/Makefile
    M python/grass/docs/conf.py
    M python/grass/docs/src/index.rst
    M python/grass/jupyter/__init__.py

  Log Message:
  -----------
  grass.jupyter: Generate API doc for Jupyter package (#2284)

- Updates documentation intro to reflect that it will be officially included in v8.2.
- Adds grass.jupyter to the libpython index TOC.
- Reduces depth of the TOC to make it more clear.
- Updates copyright year for generated files.
- Generates API doc for all grass.jupyter.
- Adds Sphix documentation build to Pylint check.
- Adds all authors to init file.

The Pylint check builds the code which Sphinx needs and there is already the pytest-based Pylint check so it could potentially do some pytest-related Sphinx tasks.

The API doc is now generated for all parts of the grass package. This make it possible for the doc to say grass.jupyter rather than just jupyter. This duplicates the generated doc for grass.script and others, but in the future this should replace the per-subpackage generated doc.




More information about the grass-commit mailing list