Skip to content

1.2.1: sphinx warnings #144

@kloczek

Description

@kloczek

Looks like sphinx documentation is not fully finished.

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
WARNING: html_static_path entry '_static' does not exist
[autosummary] generating autosummary for: api/mercantile.rst, api/mercantile.scripts.rst, api/modules.rst, authors.rst, changelog.rst, cli.rst, index.rst, install.rst, license.rst, quickstart.rst
Failed to import mercantile.
Possible hints:
* KeyError: 'mercantile'
* ModuleNotFoundError: No module named 'mercantile'
Failed to import mercantile.scripts.
Possible hints:
* KeyError: 'mercantile'
* ModuleNotFoundError: No module named 'mercantile'
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 10 added, 0 changed, 0 removed
reading sources... [100%] quickstart
WARNING: autodoc: failed to import module 'mercantile'; the following exception was raised:
No module named 'mercantile'
WARNING: autodoc: failed to import module 'scripts' from module 'mercantile'; the following exception was raised:
No module named 'mercantile'
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/docs/license.rst:4: ERROR: Content block expected for the "raw" directive; none found.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... mercantile.1 { quickstart install api/modules api/mercantile api/mercantile.scripts cli changelog license authors } done
build succeeded, 4 warnings.

Module cannot be loaded because it is not available on sys.path.
This can be fixed by below patch

--- a/docs/conf.py~     2021-04-21 14:36:07.000000000 +0000
+++ b/docs/conf.py      2022-04-16 14:37:57.761724925 +0000
@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 # Mercantile documentation build configuration file, created by
@@ -22,7 +21,7 @@
 import os
 import sys

-sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath(".."))

 # -- General configuration ------------------------------------------------

(first line is not needed )
After apply that patch however latest sphinx show even more warnings

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
WARNING: html_static_path entry '_static' does not exist
[autosummary] generating autosummary for: api/mercantile.rst, api/mercantile.scripts.rst, api/modules.rst, authors.rst, changelog.rst, cli.rst, index.rst, install.rst, license.rst, quickstart.rst
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 10 added, 0 changed, 0 removed
reading sources... [100%] quickstart
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Bbox:24: WARNING: autosummary: stub file not found 'mercantile.Bbox.count'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Bbox:24: WARNING: autosummary: stub file not found 'mercantile.Bbox.index'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLat:24: WARNING: autosummary: stub file not found 'mercantile.LngLat.count'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLat:24: WARNING: autosummary: stub file not found 'mercantile.LngLat.index'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLatBbox:24: WARNING: autosummary: stub file not found 'mercantile.LngLatBbox.count'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLatBbox:24: WARNING: autosummary: stub file not found 'mercantile.LngLatBbox.index'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Tile:24: WARNING: autosummary: stub file not found 'mercantile.Tile.count'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Tile:24: WARNING: autosummary: stub file not found 'mercantile.Tile.index'. Check your autosummary_generate setting.
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/docs/license.rst:4: ERROR: Content block expected for the "raw" directive; none found.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-mercantile.3 { quickstart install api/modules api/mercantile api/mercantile.scripts cli changelog license authors } /home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Bbox:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.Bbox.count
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Bbox:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.Bbox.index
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLat:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.LngLat.count
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLat:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.LngLat.index
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLatBbox:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.LngLatBbox.count
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.LngLatBbox:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.LngLatBbox.index
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Tile:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.Tile.count
/home/tkloczko/rpmbuild/BUILD/mercantile-1.2.1/mercantile/__init__.py:docstring of mercantile.Tile:29:<autosummary>:1: WARNING: py:obj reference target not found: mercantile.Tile.index
done
build succeeded, 18 warnings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions