Skip to content

/ cython

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] 0.29.22: sphinx warnings #4217

Open
kloczek opened this issue Jun 9, 2021 · 1 comment
Open

[BUG] 0.29.22: sphinx warnings #4217

kloczek opened this issue Jun 9, 2021 · 1 comment
Labels
Documentation good first issue

Comments

@kloczek
Copy link

@kloczek kloczek commented Jun 9, 2021

After add patch which fixes #4209 I found that sphinx emits some warnings.

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
Unable to find pgen, not compiling formal grammar.
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 53 added, 0 changed, 0 removed
reading sources... [100%] src/userguide/wrapping_CPlusPlus
CHANGES.rst:1694: WARNING: Inline emphasis start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/quickstart/install.rst:62: WARNING: duplicate citation Sage, other instance in /home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/quickstart/build.rst
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/related_work.rst:44: WARNING: duplicate citation Pyrex, other instance in /home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/quickstart/overview.rst
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/extension_types.rst:853: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/memoryviews.rst:19: WARNING: Unknown target name: "pep 3118".
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/memoryviews.rst:230: WARNING: Unknown target name: "new style buffers".
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/memoryviews.rst:230: WARNING: Unknown target name: "pep 3118".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/CONTRIBUTING.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/examples/README.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/directives.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/extension_types.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/index.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/interfacing_with_other_code.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/language_basics.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/limitations.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/reference/special_mention.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/quickstart/overview.rst:46: WARNING: Citation [Cython] is not referenced.
done
writing... python-cython.3 { src/quickstart/index src/quickstart/overview src/quickstart/install src/quickstart/build src/quickstart/cythonize src/tutorial/index src/tutorial/cython_tutorial src/tutorial/external src/tutorial/clibraries src/tutorial/cdef_classes src/tutorial/pxd_files src/tutorial/caveats src/tutorial/profiling_tutorial src/tutorial/strings src/tutorial/memory_allocation src/tutorial/pure src/tutorial/numpy src/tutorial/array src/tutorial/readings src/tutorial/related_work src/tutorial/appendix src/userguide/index src/userguide/language_basics src/userguide/extension_types src/userguide/special_methods src/userguide/sharing_declarations src/userguide/external_C_code src/userguide/source_files_and_compilation src/userguide/early_binding_for_speed src/userguide/wrapping_CPlusPlus src/userguide/fusedtypes src/userguide/pypy src/userguide/limitations src/userguide/pyrex_differences src/userguide/memoryviews src/userguide/buffer src/userguide/parallelism src/userguide/debugging src/userguide/numpy_tutorial src/userguide/numpy_pythran src/changes } /home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/clibraries.rst:537: WARNING: Unparseable C cross-reference: 'void*'
Invalid C declaration: Expected identifier in nested name, got keyword: void [error at 4]
  void*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/clibraries.rst:567: WARNING: Unparseable C cross-reference: 'void*'
Invalid C declaration: Expected identifier in nested name, got keyword: void [error at 4]
  void*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/clibraries.rst:567: WARNING: Unparseable C cross-reference: 'void*'
Invalid C declaration: Expected identifier in nested name, got keyword: void [error at 4]
  void*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:164: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:169: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:323: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:347: WARNING: Unparseable C cross-reference: 'std::string'
Invalid C declaration: Expected end of definition. [error at 3]
  std::string
  ---^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:476: WARNING: Unparseable C cross-reference: 'char'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:490: WARNING: Unparseable C cross-reference: 'char'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:490: WARNING: Unparseable C cross-reference: 'char'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:508: WARNING: Unparseable C cross-reference: 'char'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:508: WARNING: Unparseable C cross-reference: 'unsigned char'
Invalid C declaration: Expected identifier in nested name, got keyword: unsigned [error at 8]
  unsigned char
  --------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:532: WARNING: Unparseable C cross-reference: 'long'
Invalid C declaration: Expected identifier in nested name, got keyword: long [error at 4]
  long
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:532: WARNING: Unparseable C cross-reference: 'unsigned long'
Invalid C declaration: Expected identifier in nested name, got keyword: unsigned [error at 8]
  unsigned long
  --------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:532: WARNING: Unparseable C cross-reference: 'int'
Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 3]
  int
  ---^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:613: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:650: WARNING: Unparseable C cross-reference: 'wchar_t*'
Invalid C declaration: Expected end of definition. [error at 7]
  wchar_t*
  -------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:660: WARNING: Unparseable C cross-reference: 'Py_UNICODE*'
Invalid C declaration: Expected end of definition. [error at 10]
  Py_UNICODE*
  ----------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:660: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:666: WARNING: Unparseable C cross-reference: 'Py_UNICODE*'
Invalid C declaration: Expected end of definition. [error at 10]
  Py_UNICODE*
  ----------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/tutorial/strings.rst:686: WARNING: Unparseable C cross-reference: 'Py_UNICODE*'
Invalid C declaration: Expected end of definition. [error at 10]
  Py_UNICODE*
  ----------^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/language_basics.rst:245: WARNING: unknown keyword: None
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/language_basics.rst:245: WARNING: unknown keyword: False
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/language_basics.rst:245: WARNING: unknown keyword: NULL
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/special_methods.rst:14: WARNING: unknown keyword: cdef class
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/external_C_code.rst:98: WARNING: Unparseable C cross-reference: 'int'
Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 3]
  int
  ---^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/external_C_code.rst:98: WARNING: Unparseable C cross-reference: 'int'
Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 3]
  int
  ---^
/home/tkloczko/rpmbuild/BUILD/cython-0.29.22/docs/src/userguide/pypy.rst:66: WARNING: Unparseable C cross-reference: 'char*'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char*
  ----^
done
build succeeded, 45 warnings.
@scoder
Copy link
Contributor

@scoder scoder commented Jun 9, 2021

Yeah, there are a couple of issues here. One thing is that the C data type cross reference apparently doesn't work. Not sure why. The rest are mostly legitimate ReST issues.

Help is welcome.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@scoder @kloczek