kloczek
commented
3 years ago Closed kloczek closed 3 years ago
kloczek
commented
3 years ago 
nicholascar
commented
3 years ago There is a major PR, https://github.com/RDFLib/rdflib/pull/1296, to address documentation so I propose revisiting this Issue when that PR is merged. I didn't specifically address all these issues in that PR but so much docco has changed, teh results will surely be different.
nicholascar
commented
3 years ago I've resolved many of the warnings but there are still a couple here-and-there and new PRs keep adding more since doctest warnings don't break CICD
kloczek
commented
3 years ago At the moment seems is like +500 on top of last release. Is it any plan to make new release soon? I'm asking because I cannot test that PR on top of laste release because that PR patch does not applies cleanly.
nicholascar
commented
3 years ago The plan is to make the 6.0.0 release now (in a day or so) since we've merged all the PRs that we really wanted to (see https://github.com/RDFLib/rdflib/projects/1). The documentation is rebuilding, just, so we have latest on 6.0.0-alpha already: https://rdflib.readthedocs.io/en/latest/
kloczek
commented
3 years ago Just started tssting 6.0.0. Here is output generated with sphinx 4.0.3
+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.0.3
making output directory... done
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.extras.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.namespace.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.parsers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.serializers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.shared.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.shared.jsonld.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.sparql.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.sparql.results.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.stores.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.tools.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/modules.rst.
loading intersphinx inventory from https://docs.python.org/3.7/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 35 added, 0 changed, 0 removed
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace DCAT
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace PROF
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SDO
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SOSA
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SSN
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace TIME
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace XSD
partialmethod = obj._partialmethod
reading sources... [100%] utilities
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/namespace/__init__.py:docstring of rdflib.namespace:63: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 9 supplied.
.. code-block:: pycon
>>> from rdflib.namespace import RDFS
>>> RDFS.seeAlso
rdflib.term.URIRef('http://www.w3.org/2000/01/rdf-schema#seeAlso')
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:3: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:4: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-rdflib.3 { gettingstarted intro_to_parsing intro_to_creating_rdf intro_to_graphs intro_to_sparql utilities apidocs/examples rdf_terms namespaces_and_bindings persistence merging upgrade5to6 upgrade4to5 apidocs/modules apidocs/rdflib apidocs/rdflib.extras apidocs/rdflib.namespace apidocs/rdflib.plugins apidocs/rdflib.plugins.parsers apidocs/rdflib.plugins.serializers apidocs/rdflib.plugins.shared apidocs/rdflib.plugins.shared.jsonld apidocs/rdflib.plugins.sparql apidocs/rdflib.plugins.sparql.results apidocs/rdflib.plugins.stores apidocs/rdflib.tools plugins plugin_parsers plugin_serializers plugin_stores plugin_query_results developers docs persisting_n3_terms } done
build succeeded, 7 warnings.Thanks @kloczek. I know about those but I'm struggling to deal with them.
The _partialmethod warnings we can safely ignore here: these are elements of our DefinedNamespace class that we might improve the handling of, but they don't affect documentation.
The 6 warnings from SPARQLStore.triples & SPARQLUpdateStore.triples I can't work out how to fix! I've fixed the formatting a fair bit (down from 19 errors) but I can't see what the remaining 6 issues need changing to fix.
kloczek
commented
3 years ago Just tested with sphinx 4.1.2 and it looks like it is yet another issue:
+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.1.2
making output directory... done
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.extras.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.namespace.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.parsers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.serializers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.shared.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.shared.jsonld.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.sparql.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.sparql.results.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.plugins.stores.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/rdflib.tools.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.0/docs/apidocs/modules.rst.
loading intersphinx inventory from https://docs.python.org/3.7/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 35 added, 0 changed, 0 removed
reading sources... [ 8%] apidocs/rdflib
Recursion error:
maximum recursion depth exceeded while calling a Python object
This can happen with very large or deeply nested source files. You can carefully increase the default Python recursion limit of 1000 in conf.py with e.g.:
import sys; sys.setrecursionlimit(1500)Looks like 6.0.2 is way better now :)
+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.2.0
making output directory... done
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.extras.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.namespace.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.parsers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.serializers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.shared.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.shared.jsonld.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.sparql.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.sparql.results.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.plugins.stores.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/rdflib.tools.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/docs/apidocs/modules.rst.
loading intersphinx inventory from https://docs.python.org/3.7/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 35 added, 0 changed, 0 removed
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace DCAT
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace PROF
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SDO
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SOSA
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SSN
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace TIME
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace XSD
partialmethod = obj._partialmethod
reading sources... [100%] utilities
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/namespace/__init__.py:docstring of rdflib.namespace:64: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 9 supplied.
.. code-block:: pycon
>>> from rdflib.namespace import RDFS
>>> RDFS.seeAlso
rdflib.term.URIRef('http://www.w3.org/2000/01/rdf-schema#seeAlso')
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:3: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:4: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.0.2/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-rdflib.3 { gettingstarted intro_to_parsing intro_to_creating_rdf intro_to_graphs intro_to_sparql utilities apidocs/examples rdf_terms namespaces_and_bindings persistence merging upgrade5to6 upgrade4to5 apidocs/modules apidocs/rdflib apidocs/rdflib.extras apidocs/rdflib.namespace apidocs/rdflib.plugins apidocs/rdflib.plugins.parsers apidocs/rdflib.plugins.serializers apidocs/rdflib.plugins.shared apidocs/rdflib.plugins.shared.jsonld apidocs/rdflib.plugins.sparql apidocs/rdflib.plugins.sparql.results apidocs/rdflib.plugins.stores apidocs/rdflib.tools plugins plugin_parsers plugin_serializers plugin_stores plugin_query_results developers docs persisting_n3_terms } done
build succeeded, 7 warnings.Unfortunately I still get the recursion error you see two comments up. I really have no idea how to fix this, especially as you, and readthedocs don't seem to get the error.
kloczek
commented
2 years ago Just only FTR. Here is result on top of 6.1.0
+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.3.1
making output directory... done
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.extras.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.namespace.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.parsers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.serializers.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.shared.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.shared.jsonld.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.sparql.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.sparql.results.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.plugins.stores.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/rdflib.tools.rst.
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/apidocs/modules.rst.
loading intersphinx inventory from https://docs.python.org/3.7/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 35 added, 0 changed, 0 removed
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace BRICK
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace DCAT
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace PROF
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SDO
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SOSA
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace SSN
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace TIME
partialmethod = obj._partialmethod
/usr/lib64/python3.8/inspect.py:2270: UserWarning: Code: _partialmethod is not defined in namespace XSD
partialmethod = obj._partialmethod
reading sources... [100%] utilities
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/namespace/__init__.py:docstring of rdflib.namespace:64: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 9 supplied.
.. code-block:: pycon
>>> from rdflib.namespace import RDFS
>>> RDFS.seeAlso
rdflib.term.URIRef('http://www.w3.org/2000/01/rdf-schema#seeAlso')
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:3: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.open:4: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:27: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/rdflib/plugins/stores/sparqlstore.py:docstring of rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore.triples:29: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/developers.rst:14: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/rdflib-6.1.0/docs/intro_to_parsing.rst:113: WARNING: Explicit markup ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-rdflib.3 { gettingstarted intro_to_parsing intro_to_creating_rdf intro_to_graphs intro_to_sparql utilities apidocs/examples rdf_terms namespaces_and_bindings persistence merging upgrade5to6 upgrade4to5 apidocs/modules apidocs/rdflib apidocs/rdflib.extras apidocs/rdflib.namespace apidocs/rdflib.plugins apidocs/rdflib.plugins.parsers apidocs/rdflib.plugins.serializers apidocs/rdflib.plugins.shared apidocs/rdflib.plugins.shared.jsonld apidocs/rdflib.plugins.sparql apidocs/rdflib.plugins.sparql.results apidocs/rdflib.plugins.stores apidocs/rdflib.tools plugins plugin_parsers plugin_serializers plugin_stores plugin_query_results developers docs persisting_n3_terms } done
build succeeded, 9 warnings.