https://github.com/sphinx-contrib/cmakedomain

https://github.com/sphinx-contrib/cmakedomain

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/cmakedomain
• Owner: sphinx-contrib
• License: other
• Created: 2017-09-28T10:31:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-28T10:31:50.000Z (over 7 years ago)
• Last Synced: 2025-01-12T01:25:55.103Z (4 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
GNU Make Domain

===============

This `Sphinx extension`_ provides a `CMake`_ `domain`_.

.. _Sphinx extension: http://sphinx-doc.org

.. _GNU Make: http://cmake.org

.. _domain: http://sphinx-doc.org/domains.html

Installation

------------

::

    pip install sphinxcontrib-cmakedomain

Enable Extension

----------------

Add ``sphinxcontrib.cmakedomain`` in ``extensions`` of `conf.py`::

    extensions = [ 'sphinxcontrib.cmakedomain' ]

Usage

-----

Get ready for make::

    .. highlight:: cmake

    .. default-domain:: make

Describe a macro::

    .. macro:: foo(SOME  ANOTHER )

       :param SOME :

           here description

       :param ANOTHER :

           here more descripiton

       describe here whatever :macro:`foo` does

Describe a variable::

    .. var:: MY_VAR

       Describe here whatever :var:`MY_VAR` does.

License

-------

New BSD License.

Author

------

`Kay-Uwe (Kiwi) Lorenz `_ (http://quelltexter.org)