sphinxcontrib-spelling / rubydomain /

Filename Size Date modified Message
..
doc
sphinxcontrib
test
174 B
1.4 KB
49 B
760 B
81 B
1.2 KB
===========
Ruby Domain
===========

This is the Ruby domain for Sphinx 1.0.
Sphinx 1.0 will deliver new feature -- Domain.
It will enable other language support except Python and C language.

This extension provides directives and roles to write Ruby documents.
Ruby Domain supports following objects:

* Global Variable
* Constant
* Module

  * Function
  * Method(for Mix-In)

* Class

  * Method
  * Class Method
  * Attribute

.. note::

   This domain expresses methods and attribute names like this::

      Module#method_name
      Class#method_name
      Class#attribute_name

   And other items(module function and class method) are expressed like this::

      Module.function_name
      Class.class_method_name

   Take care separator charactors!

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.