Skip to content
This repository has been archived by the owner on Feb 28, 2022. It is now read-only.

Commit

Permalink
Use include to get mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
ericholscher committed Mar 22, 2017
1 parent 2a8a48f commit eabdc1c
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions docs/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,11 @@ This is lossy becuase there are things that can be expressed in Python that can'
for example functions that live outside of a class.

The `YAML Syntax`_ is documented and should be output properly from this module.
The mapping is done as follows::

# We need to map the Python type names to what DocFX is expecting
TYPE_MAPPING = {
'method': 'Method',
'function': 'Method',
'module': 'Namespace',
'class': 'Class',
'exception': 'Class',
'attribute': 'Property',
}
The mapping is done as follows:

.. literalinclude:: ../docfx_yaml/extension.py
:start-after: TYPE_MAPPING = {
:end-before: }

Along with this mapping,
all module-level functions will be added to a proxy class called ``Global``.
Expand Down

0 comments on commit eabdc1c

Please sign in to comment.