Skip to content

4.0.0: sphinx warnings reference target not found #252

Open

Description

@kloczek

On building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.
Here is the output with warnings:

writing... python-lz4.3 { intro install quickstart userguide lz4 lz4.frame lz4.block lz4.stream contributors license } /home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:13: WARNING: py:func reference target not found: compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:13: WARNING: py:func reference target not found: decompress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:26: WARNING: py:func reference target not found: compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:26: WARNING: py:func reference target not found: decompress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:50: WARNING: py:func reference target not found: compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:50: WARNING: py:func reference target not found: compress_chunk
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:50: WARNING: py:func reference target not found: compress_flush
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:57: WARNING: py:func reference target not found: compress_flush
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:57: WARNING: py:func reference target not found: compress_chunk
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:57: WARNING: py:func reference target not found: compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:57: WARNING: py:func reference target not found: compress_flush
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:74: WARNING: py:func reference target not found: decompress_chunk
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:82: WARNING: py:class reference target not found: LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:82: WARNING: py:class reference target not found: LZ4FrameDecompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:107: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:127: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:148: WARNING: py:obj reference target not found: lz4.frame.COMPRESSIONLEVEL_MIN
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:149: WARNING: py:obj reference target not found: lz4.frame.COMPRESSIONLEVEL_MINHC
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:150: WARNING: py:obj reference target not found: lz4.frame.COMPRESSIONLEVEL_MAX
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:152: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:152: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:152: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:152: WARNING: py:class reference target not found: lz4.frame.LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:152: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:163: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_DEFAULT
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:164: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_MAX64KB
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:165: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_MAX256KB
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:166: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_MAX1MB
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:167: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_MAX4MB
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:169: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_DEFAULT
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:169: WARNING: py:obj reference target not found: lz4.frame.BLOCKSIZE_MAX64KB
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:172: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:172: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:172: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:172: WARNING: py:class reference target not found: lz4.frame.LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:172: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:185: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:185: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:185: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:185: WARNING: py:class reference target not found: lz4.frame.LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:185: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:203: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:203: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:203: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:203: WARNING: py:class reference target not found: lz4.frame.LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:203: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:222: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:222: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:222: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:222: WARNING: py:class reference target not found: lz4.frame.LZ4FrameCompressor
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:222: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:238: WARNING: py:func reference target not found: lz4.frame.compress
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:244: WARNING: py:meth reference target not found: lz4.frame.LZ4FrameCompressor.begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:244: WARNING: py:func reference target not found: lz4.frame.compress_begin
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:244: WARNING: py:func reference target not found: lz4.frame.open
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/quickstart.rst:244: WARNING: py:class reference target not found: lz4.frame.LZ4FrameFile
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.rst:5: WARNING: py:mod reference target not found: lz4.block
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.rst:5: WARNING: py:mod reference target not found: lz4.stream
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.block.rst:50: WARNING: py:obj reference target not found: uncompressed_size
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.block.rst:86: WARNING: py:obj reference target not found: lz4.block.LZ4BlockError
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.block.rst:86: WARNING: py:obj reference target not found: usize
/home/tkloczko/rpmbuild/BUILD/python-lz4-4.0.0/docs/lz4.block.rst:86: WARNING: py:obj reference target not found: max_size
done
build succeeded, 87 warnings.

Activity

  1. jonathanunderwood commented on May 2, 2022

    @jonathanunderwood
    Member

    Do you actually have the python-lz4 package installed when you're running sphinx? If not, that's what you'll see.

  2. kloczek commented on May 2, 2022

    @kloczek
    Author

    Do you actually have the python-lz4 package installed when you're running sphinx? If not, that's what you'll see.

    No and those warnings have nothing to do with that is module installed or not.
    Even if you will add to you documentation build procedure that -n switch you will be able to see those warnings.
    Instead assuming that it is related to the module installation state please make short test.

  3. jonathanunderwood commented on Dec 29, 2022

    @jonathanunderwood
    Member

    OK. Patches welcome.

  4. jonathanunderwood commented on Dec 29, 2022

    @jonathanunderwood
    Member

    Looking at these, I can't actually see what the problem is - the references are correct, and in the generated documentation the links (reference targets) are all working. Inclined to close this as won't fix, as it seems like possibly sphinx is in error. What am I missing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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