Skip to main content

Sphinx domain for describing people

Project description

Sphinx domain for describing people.

If you use sphinx as blog, you can use this domain to manange your friends link.


pip install sphinxnotes-peopledomain


Add 'sphinxnotes.peopledomain' to the extensions list in

extensions = [ 'sphinxnotes.peopledomain' ]


For now, this package provides a domain named ppl.

To create a description of your friend, use friend directive:

.. ppl:friend:: SilverRainZ


Then you can use role :ppl:friend:`SilverRainZ` to refer him. It will be rendered as “@SilverRainZ” with the appropriate link.



Provide the “ppl” domain, “friend” directive and “friend” role.

  • Reanme the namespace from “sphinxcontrib” to “sphinxnotes”

  • Fix the import error of make_id

Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxnotes-peopledomain-0.2.tar.gz (3.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page