Add virtual namespaces and abstract templates into extended bases

autoapi/base.py

@@ -9,6 +9,7 @@ class AutoAPIBase(object):
     def __init__(self, obj):
         self.obj = obj
 
+
     def render(self, ctx=None):
         if not ctx:
             ctx = {}
@@ -18,6 +19,12 @@ class AutoAPIBase(object):
         ctx.update(**self.__dict__)
         return template.render(**ctx)
 
+    def get_absolute_path(self):
+        return "/autoapi/{type}/{name}".format(
+            type=self.type,
+            name=self.name,
+        )
+
 
 class UnknownType(AutoAPIBase):
 

autoapi/dotnet.py

@@ -32,6 +32,13 @@ class DotNetBase(AutoAPIBase):
             self.item_map = defaultdict(list)
             self.sort()
 
+    @property
+    def ref_type(self):
+        return self.type.lower().replace('class', 'cls').replace('interface', 'iface').replace('delegate', 'del')
+
+    def to_ref_type(self, _type):
+        return _type.lower().replace('class', 'cls').replace('interface', 'iface').replace('delegate', 'del')
+
     def sort(self):
         from .utils import classify
         for item in self.children:
@@ -81,5 +88,18 @@ class DotNetClass(DotNetBase):
 class DotNetField(DotNetBase):
     type = 'field'
 
+
 class DotNetEvent(DotNetBase):
     type = 'event'
+
+
+class VirtualNamespace(AutoAPIBase):
+    language = 'dotnet'
+    type = 'namespace'
+
+    def __init__(self, name, objs):
+        self.name = self.short_name = name
+        self.children = []
+        self.type = 'namespace'
+        for obj in objs:
+            self.children.append(obj.obj)

autoapi/extension.py

@@ -8,12 +8,13 @@ import yaml
 import fnmatch
 import shutil
 from collections import defaultdict
+import traceback
 
 from sphinx.util.osutil import ensuredir
 from sphinx.util.console import bold, darkgreen
 
 from .utils import classify
-# from .dotnet import DotNetNamespace
+from .dotnet import VirtualNamespace
 
 from epyparse import parsed
 
@@ -42,14 +43,22 @@ def load_yaml(app):
             # print "Loading Yaml from %s" % _file
             to_open = os.path.join(app.config.autoapi_dir, _file)
             yaml_obj = yaml.safe_load(open(to_open, 'r'))
-            app.env.autoapi_data.append(classify(yaml_obj, 'dotnet'))
+            obj = classify(yaml_obj, 'dotnet')
+            app.env.autoapi_data.append(obj)
+            # Add to namespace dict
+            if yaml_obj.get('type') != 'Namespace':
+                try:
+                    top, mid, last = obj.name.split('.')[0:3]
+                    namespaces[top].append(obj)
+                    namespaces[top+'.'+mid].append(obj)
+                    namespaces[top+'.'+mid+'.'+last].append(obj)
+                except:
+                    traceback.print_exc()
+                    pass
 
         # print "Sorting objects"
         # Sort objects
         # for obj in app.env.autoapi_data:
-            # obj_name = obj['qualifiedName']['CSharp']
-            # namespace = obj_name.split('.')[0]
-            # namespaces[namespace].append(classify(obj, 'dotnet'))
             # rst = parse(obj, 'dotnet')
             # if rst:
             #     path = os.path.join(app.config.autoapi_root, '%s%s' % (obj['name']['CSharp'], app.config.source_suffix[0]))
@@ -78,6 +87,17 @@ def load_yaml(app):
                 with open(path, 'w+') as detail_file:
                     detail_file.write(rst)
 
+        for namespace, objs in namespaces.items():
+            namespace_obj = VirtualNamespace(namespace, objs)
+            ensuredir(app.config.autoapi_root)
+            virtual_dir = os.path.join(app.config.autoapi_root, 'Virtual')
+            ensuredir(virtual_dir)
+            virtual_path = os.path.join(virtual_dir, '%s%s' % (namespace, app.config.source_suffix[0]))
+            with open(virtual_path, 'w+') as index_file:
+                namespace_rst = namespace_obj.render()
+                if namespace_rst:
+                    index_file.write(namespace_rst)
+
     elif app.config.autoapi_type == 'python':
         for root, dirnames, filenames in os.walk(app.config.autoapi_dir):
             for filename in fnmatch.filter(filenames, u'*.py'):

autoapi/templates/dotnet/base_detail.rst

@@ -0,0 +1,60 @@
+{% block title %}
+
+{{ short_name }} {{ type.title()}}
+{{ "=" * (short_name|length + type|length + 1) }}
+
+.. dn:{{ type.lower().replace('struct', 'structure').replace('enum', 'enumeration') }}:: {{ name }}
+
+{% endblock %}
+
+{% block summary %}
+
+Summary
+-------
+
+{{ summary }}
+
+{% endblock %}
+
+{% block inheritance %}
+
+Inheritance Hierarchy
+---------------------
+
+{% for item in inheritance %}
+* :ref:`{{ item.id }}`
+{% endfor %}
+
+{% endblock %}
+
+{% block syntax %}
+
+Syntax
+------
+
+.. code-block:: csharp
+
+   {{ syntax }}
+
+{% endblock %}
+
+
+{% block content %}
+
+{% if item_map %}
+
+{% for obj_type, obj_list in item_map.items() %}
+
+{{ obj_type }}
+{{ "-" * obj_type|length }}
+
+{% for obj_item in obj_list %}
+{% macro render() %}{{ obj_item.render() }}{% endmacro %}
+{{ render()|indent(0) }}
+{% endfor %}
+
+{% endfor %}
+
+{% endif %}
+
+{% endblock %}

autoapi/templates/dotnet/base_embed.rst

@@ -0,0 +1,12 @@
+.. dn:{{ type.lower() }}:: {{ name }}
+
+	{% if summary %}
+
+    {% macro render() %}{{ summary }}{% endmacro %}
+    {{ render()|indent(4) }}
+
+	{% endif %}
+
+	.. code-block:: csharp
+
+	   {{ syntax }}

autoapi/templates/dotnet/base_list.rst

@@ -0,0 +1,42 @@
+{% block title %}
+
+{{ short_name }} {{ type.title()}}
+{{ "=" * (short_name|length + type|length + 1) }}
+
+{% endblock %}
+
+{% block toc %}
+
+{% if children %}
+
+.. toctree::
+   :hidden:
+
+   {%- for item in children %} 
+   {# {{ item.get_absolute_path }}  #}
+   /autoapi/{{ item.type }}/{{ item.id.split('.')[-1] }}
+   {%- endfor %}
+
+{% endif %}
+
+{% endblock %}
+
+{% block table %}
+
+{% if children %}
+
+.. list-table:: Classes
+   :widths: 20, 80
+   :header-rows: 1
+
+   * - Class
+     - Description
+   {%- for item in children %}
+   {% macro render() %}{{ item.summary }}{% endmacro %}
+   * - :dn:{{ item.type.lower().replace('class', 'cls').replace('interface', 'iface').replace('delegate', 'del') }}:`{{ item.id }}`
+     - {{ render()|indent(7) }}
+   {% endfor %}
+
+{% endif %}
+
+{% endblock %}

autoapi/templates/dotnet/class.rst

@@ -1,41 +1 @@
-{{ short_name }} {{ type.title()}}
+{% extends "dotnet/base_detail.rst" %}
-{{ "=" * (short_name|length + type|length + 1) }}
-
-.. dn:class:: {{ name }}
-
-Summary
--------
-
-{{ summary }}
-
-Inheritance Hierarchy
----------------------
-
-{% for item in inheritance %}
-* :ref:`{{ item.id }}`
-{% endfor %}
-
-Syntax
-------
-
-.. code-block:: csharp
-
-   {{ syntax }}
-
-{% if item_map %}
-
-{% for obj_type, obj_list in item_map.items() %}
-
-{{ obj_type }}
-{{ "-" * obj_type|length }}
-
-{% for obj_item in obj_list %}
-{% macro render() %}{{ obj_item.render() }}{% endmacro %}
-{{ render()|indent(0) }}
-{% endfor %}
-
-{% endfor %}
-
-{% endif %}
-
-

autoapi/templates/dotnet/constructor.rst

@@ -1,12 +1 @@
-.. dn:{{ type.lower() }}:: {{ name }}
+{% extends "dotnet/base_embed.rst" %}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-    
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/delegate.rst

@@ -1,15 +1 @@
-{{ short_name }}
+{% extends "dotnet/base_detail.rst" %}
-{{  "=" * short_name|length }}
-
-.. dn:delegate:: {{ name }}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/enum.rst

@@ -1,39 +1 @@
-{{ short_name }} {{ type.title()}}
+{% extends "dotnet/base_detail.rst" %}
-{{ "=" * (short_name|length + type|length + 1) }}
-
-.. dn:enumeration:: {{ name }}
-
-Summary
--------
-
-{{ summary }}
-
-Inheritance Hierarchy
----------------------
-
-{% for item in inheritance %}
-* :ref:`{{ item.id }}`
-{% endfor %}
-
-Syntax
-------
-
-.. code-block:: csharp
-
-   {{ syntax }}
-
-{% if item_map %}
-
-{% for obj_type, obj_list in item_map.items() %}
-
-{{ obj_type }}
-{{ "-" * obj_type|length }}
-
-{% for obj_item in obj_list %}
-{% macro render() %}{{ obj_item.render() }}{% endmacro %}
-{{ render()|indent(0) }}
-{% endfor %}
-
-{% endfor %}
-
-{% endif %}

autoapi/templates/dotnet/event.rst

@@ -1,12 +1 @@
-.. dn:{{ type.lower() }}:: {{ name }}
+{% extends "dotnet/base_embed.rst" %}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/field.rst

@@ -1,12 +1 @@
-.. dn:{{ type.lower() }}:: {{ name }}
+{% extends "dotnet/base_embed.rst" %}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/interface.rst

@@ -1,40 +1 @@
-{{ short_name }} {{ type.title()}}
+{% extends "dotnet/base_detail.rst" %}
-{{ "=" * short_name|length }}{{ "=" * type|length }}=
-
-.. dn:interface:: {{ name }}
-
-Summary
--------
-
-{{ summary }}
-
-Inheritance Hierarchy
----------------------
-
-{% for item in inheritance %}
-* :ref:`{{ item.id }}`
-{% endfor %}
-
-Syntax
-------
-
-.. code-block:: csharp
-
-   {{ syntax }}
-
-
-{% if item_map %}
-
-{% for obj_type, obj_list in item_map.items() %}
-
-{{ obj_type }}
-{{ "-" * obj_type|length }}
-
-{% for obj_item in obj_list %}
-{% macro render() %}{{ obj_item.render() }}{% endmacro %}
-{{ render()|indent(0) }}
-{% endfor %}
-
-{% endfor %}
-
-{% endif %}

autoapi/templates/dotnet/method.rst

@@ -1,12 +1 @@
-.. dn:{{ type.lower() }}:: {{ name }}
+{% extends "dotnet/base_embed.rst" %}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/namespace.rst

@@ -1,33 +1 @@
-{{ short_name }} {{ type.title()}}
+{% extends "dotnet/base_list.rst" %}
-{{ "=" * short_name|length }}{{ "=" * type|length }}=
-
-Tree:
-
-{% if children %}
-
-.. toctree::
-   :hidden:
-   {% for item in children %} 
-   /autoapi/{{ item.type }}/{{ item.id.split('.')[-1] }} {% endfor %}
-
-{% endif %}
-
-Table:
-
-
-{% if children %}
-
-.. list-table:: Classes
-   :widths: 20, 80
-   :header-rows: 1
-
-   * - Class
-     - Description
-{% for item in children %} {% macro render() %}{{ item.summary }}{% endmacro %}
-   * - :dn:{{ item.type.lower().replace('class', 'cls').replace('interface', 'iface').replace('delegate', 'del') }}:`{{ item.id }}`
-     - {{ render()|indent(7) }}
-{% endfor %}
-
-
-
-{% endif %}

autoapi/templates/dotnet/property.rst

@@ -1,12 +1 @@
-.. dn:{{ type.lower() }}:: {{ name }}
+{% extends "dotnet/base_embed.rst" %}
-
-	{% if summary %}
-
-    {% macro render() %}{{ summary }}{% endmacro %}
-    {{ render()|indent(4) }}
-
-	{% endif %}
-
-	.. code-block:: csharp
-
-	   {{ syntax }}

autoapi/templates/dotnet/struct.rst

@@ -1,39 +1 @@
-{{ short_name }} {{ type.title()}}
+{% extends "dotnet/base_detail.rst" %}
-{{ "=" * short_name|length }}{{ "=" * type|length }}=
-
-.. dn:structure:: {{ name }}
-
-Summary
--------
-
-{{ summary }}
-
-Inheritance Hierarchy
----------------------
-
-{% for item in inheritance %}
-* :ref:`{{ item.id }}`
-{% endfor %}
-
-Syntax
-------
-
-.. code-block:: csharp
-
-   {{ syntax }}
-
-{% if item_map %}
-
-{% for obj_type, obj_list in item_map.items() %}
-
-{{ obj_type }}
-{{ "-" * obj_type|length }}
-
-{% for obj_item in obj_list %}
-{% macro render() %}{{ obj_item.render() }}{% endmacro %}
-{{ render()|indent(0) }}
-{% endfor %}
-
-{% endfor %}
-
-{% endif %}