Documentation rework that plugins usage and modules are crosslinked #3320
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is work in correspondence to my issue #3307
This targets better findability of plugins, here only with more documentation links and better descriptions.
current documentation status
The plugin documentation links to base modules, that contain builtin plugins. The plugin modules dont have any more detailed description there. But in general they list their submodules and each submodule equals one plugin.
Methods, that use the plugins generally link only to some example plugins.
graph._init__; graph.serialize; graph.parse; Result.serialize.The general rdflib.plugin module isnt connected to any specific plugin module.
goal of pr
There should be a link between methods and their used specific plugin modules and vice versa.
I want to link all plugin-able thingies to the general plugin module rdflib.plugin:
graph.parsewithplugins.parsers;graph.serializewith plugins.serializers`;Result.serializewith plugins.sparql.results`;graph.__init__with plugins.stores`rdflib.pluginAlso i added a base description for Serilalizer.serialize
Summary of changes
Reworked description for all modules, that are linked as plugin description.
Added crosslink for plugin related things. linked. See list in goals.
Reworked description of
Graph.__init__I added a base description for Serilalizer.serialize
No change outside from documentation.
Checklist
the same change.
so maintainers can fix minor issues and keep your PR up to date.