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.

Installation

pip install sphinxnotes-peopledomain

Configuration

Add 'sphinxnotes.peopledomain' to the extensions list in conf.py:

extensions = [ 'sphinxnotes.peopledomain' ]

Usage

For now, this package provides a domain named ppl.

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

.. ppl:friend:: SilverRainZ
   :homepage: https://silverrainz.me

   Human.

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

Changelog

0.1

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

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

  • Fix the import error of make_id

Project details


Release history Release notifications | RSS feed

This version

0.2

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 Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page