[dev] Init doc

docascode · Jun 11, 2018 · 100143b · 100143b
1 parent b5f7aa2
commit 100143b
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 2 deletions.
diff --git a/docfx_yaml/extension.py b/docfx_yaml/extension.py
@@ -449,7 +449,7 @@ def build_finished(app, exception):
     def find_node_in_toc_tree(toc_yaml, to_add_node):
         for module in toc_yaml:
             if module['name'] == to_add_node:
-                return module;
+                return module
 
             if 'items' in module:
                 items = module['items']

diff --git a/docfx_yaml/monkeypatch.py b/docfx_yaml/monkeypatch.py
@@ -141,7 +141,7 @@ def patch_docfields(app):
     `here <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/directives/__init__.py#L180>`_.
 
     This also performs the RST doctree to Markdown transformation on the content,
-    using the :any:`docfx_yaml.writers.MarkdownWriter`.
+    using the :class:`docfx_yaml.writers.MarkdownWriter`.
     """
 
     transform_node = partial(_transform_node, app)

diff --git a/docs/markup_reference.rst b/docs/markup_reference.rst
@@ -0,0 +1,39 @@
+==================
+Markup References
+==================
+
+---------------------------------------------------------------------------
+This is a reference of markups supported by `sphinx-docfx-yaml` extension.
+---------------------------------------------------------------------------
+
+
+You can write your doc strings in two kinds of styles.
+
+reStrctureText
+===============
+reStrctureText is a 
+Supported field lists:
+- :param:
+- :args:
+- :return:
+- :retype:
+
+refering:
+- :class:
+- :py:meth:
+- :func:
+- ::
+
+Google/Numpy
+=============
+Args (alias of Parameters)
+Arguments (alias of Parameters)
+Example
+Examples
+Methods
+Parameters
+Return (alias of Returns)
+Returns
+Raises
+References
+See Also