https://github.com/danhunsaker/sphinxcontrib-dartdomain

Provides a Sphinx domain to document Dart packages
https://github.com/danhunsaker/sphinxcontrib-dartdomain

dartlang sphinx-extension

Last synced: 5 days ago
JSON representation

Provides a Sphinx domain to document Dart packages

• Host: GitHub
• URL: https://github.com/danhunsaker/sphinxcontrib-dartdomain
• Owner: danhunsaker
• License: other
• Created: 2023-01-15T20:36:23.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-15T21:12:30.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T06:41:34.373Z (7 months ago)
• Topics: dartlang, sphinx-extension
• Language: Python
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        
Dart Domain

###########

:author: Hennik Hunsaker 

About

=====

A domain for sphinx >= 1.0 that provides language support for Dart.

The Dart Domain supports the following objects:

* Packages

  * Variables

  * Functions

  * Classes

    * Constants

    * Methods

    * Properties

URLs

====

:PyPI: http://pypi.python.org/pypi/sphinxcontrib-dartdomain

:Detailed Documentation: https://pythonhosted.org/sphinxcontrib-dartdomain/

Quick Sample

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

This is source::

   .. dart:package:: package_info_plus

      .. dart:class:: PackageInfo

         .. dart:method:: fromPlatform()

            :returns: Future\<:dart:class:`PackageInfo`>

Result

------

.. dart:package:: package_info_plus

   .. dart:class:: PackageInfo

      .. dart:method:: fromPlatform()

         :returns: Future\<:dart:class:`PackageInfo`>

Cross referencing

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

From other places, you can create cross references like this::

   Once you install :dart:pkg:`package_info_plus`, you can use

   :dart:meth:`package_info_plus.PackageInfo.fromPlatform` to initialize the

   static attributes of the class.

Result

------

Once you install :dart:pkg:`package_info_plus`, you can use

:dart:meth:`package_info_plus.PackageInfo.fromPlatform` to initialize the

static attributes of the class.

Install

=======

You can install ``dartdomain`` using ``pip``::

   pip -U sphinxcontrib-dartdomain