Skip to content

Conversation

@WhiteGobo
Copy link
Contributor

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.parse with plugins.parsers;
  • graph.serialize with plugins.serializers`;
  • Result.serialize with plugins.sparql.results`;
  • graph.__init__ with plugins.stores`
  • everything to rdflib.plugin

Also 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

  • Checked that there aren't other open pull requests for
    the same change.
  • Checked that all tests and type checking passes.
  • If the change adds new features or changes the RDFLib public API:
  • If the change has a potential impact on users of this project:
    • Considered adding additional documentation.
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

WhiteGobo and others added 3 commits November 20, 2025 13:08
…iption. Added crosslink for plugin related things. linked: Graph.serialize - rdflib.plugins.serializers; Graph.parse - rdflib.plugins.parsers; Result.serialize - rdflib.plugins.sparql.results; Graph.__init__ - rdflib.plugins.stores;
@nicholascar nicholascar self-requested a review November 20, 2025 17:15
Copy link
Member

@nicholascar nicholascar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful to have a documentation PR! Thanks @WhiteGobo

@nicholascar nicholascar merged commit 39aaa8c into RDFLib:7.x Nov 20, 2025
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants