Source

sphinxcontrib-makedomain /

Filename Size Date modified Message
sphinxcontrib
1.5 KB
39 B
162 B
1.0 KB
81 B
1.2 KB
868 B

GNU Make Domain

This Sphinx extension provides a GNU Make domain.

Installation

pip install sphinxcontrib-makedomain

Enable Extension

Add sphinxcontrib.makedomain in extensions of conf.py:

extensions = [ 'sphinxcontrib.makedomain' ]

Usage

Get ready for make:

.. highlight:: make

.. default-domain:: make

Describe a target:

.. target:: all

   describe here whatever :target:`all` does

Describe a variable:

.. var:: MY_VAR

   Describe here whatever :var:`MY_VAR` does.

Describe an exported variable:

.. expvar:: EXPORTED_VAR

   Describe here whatever :expvar:`EXPORTED_VAR` does.

   This would describe::

       export EXPORTED_VAR = some string

License

New BSD License.