Skip to content

Commit

Permalink
update mkdocs/user_guide/configuration.md
Browse files Browse the repository at this point in the history 
create an simple example and a complex example of configuration file.
  • Loading branch information
@monitor1379
monitor1379 committed Nov 28, 2016
1 parent 009e009 commit fd8e006
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 35 deletions.
19 changes: 17 additions & 2 deletions docs/mkdocs/search_index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,29 @@
},
{
"location": "/user_guide/configuration/",
"text": "Configuration\n\n\nA \nsophon.yml\n must contain following information.\n\n\n# \u6307\u5b9a\u8981\u62bd\u53d6\u7684\u4ee3\u7801\u7684\u6240\u5728\u76ee\u5f55\n# \u8bbe\u7f6e\u8be5\u76ee\u5f55\u7684\u76ee\u7684\u4e3a\u4e86\u4fdd\u8bc1python module\u80fd\u591f\u88ab\u5bfc\u5165\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a.\ncode_dir: .\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\n# \u5982\u679c\u6ca1\u6709\u6a21\u677f\uff0c\u5219\u6240\u6709tag\u5bf9\u5e94\u7684markdown doc\u5bf9\u5e94\u6dfb\u52a0\u5728page\u6587\u4ef6\u672b\u5c3e\ntemplate_dir: templates\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a./api\nbuild_dir:\n\n# \u9700\u8981\u6ce8\u610f\uff0c\u4e0a\u8ff0\u4e24\u4e2a\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u7edd\u5bf9\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u76f8\u5bf9\u8def\u5f84\n# \u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\uff0c\u5219\u662f\u76f8\u5bf9\u4e8e\u672c\u914d\u7f6e\u6587\u4ef6\u800c\u8a00\n\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\npages:\n\n# \u5982\u679c\u6709page\uff0c\u5219\u5728build_dir/\u4e0b\u751f\u6210\u540d\u4e3apage\u7684\u6587\u4ef6\n- page: index.md\n\n- page: user/bb.md # build_dir/user/bb.md\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u5219\u4f7f\u7528\u6a21\u677f\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u800ctemplate_dir\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u4f46\u6a21\u677f\u6587\u4ef6\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u5219\u4e0d\u7528\u6a21\u677f\uff0c\u5373\u521b\u5efa\u7a7a\u767dpage\u7136\u540e\u6dfb\u52a0doc\u5230\u6587\u4ef6\u672b\u5c3e\n template: user/bb.md # template_dir/user/bb.md\n\n\n- page: cc.md\n template: cc_temp.md\n # \u5982\u679c\u6ca1\u6709tags\uff0c\u5219\u4e0d\u4ece\u4ee3\u7801\u4e2d\u751f\u6210markdown\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u6a21\u677f\u6587\u4ef6\u7684\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u7a7a\n # \u5982\u679c\u6709tags\uff0c\u5219\u5bf9\u6bcf\u4e2atag\u751f\u6210markdown\n # \u5982\u679c\u6307\u5b9a\u4e86template\uff0c\u5219\u5c06template\u6587\u4ef6\u4e2d\u7684\u6bcf\u4e2a{{tag\u6807\u8bb0}}\u7f6e\u6362\u4e3a\u5bf9\u5e94\u7684markdown\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9atemplate\uff0ctags\u7684\u4f4d\u7f6e\u4f5c\u7528\u5931\u6548\uff0c\u6240\u6709markdown\u6dfb\u52a0\u5230\u6587\u4ef6\u672b\u5c3e\n tags:\n # \u6bcf\u4e00\u4e2atag\u90fd\u6709\u4e00\u4e2atag\u540d\uff0c\u7528\u4e8e\u8868\u793adoc\u5728\u6587\u4ef6\u4e2d\u7684\u4f4d\u7f6e\n # \u5982\u679c\u6709tag\u540d\uff0c\u5219\u7f6e\u6362{{tag}}\u4e3amarkdown\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709tag\u540d\uff0c\u5219\u751f\u6210\u7684doc\u6dfb\u52a0\u5728page\u7684\u672b\u5c3e\n # \u5982\u679ctag\u5185\u5bb9\u4e3a\u7a7a\uff0c\u5219\u8868\u793amarkdown doc\u4e3a\u7a7a\u5b57\u7b26\u4e32''\n\n - tag: tag1\n # \u6bcf\u4e2atag\u7684doc\u751f\u6210\u987a\u5e8f\u5e76\u4e0d\u662ftag\u5185\u90e8\u51b3\u5b9a\uff0c\u800c\u662fclasses-\nclasses_with_members-\nfunctions\n functions:\n - sss.gates.foo\n - tag: tag2\n classes:\n - sss.gates.Dense\n - sss.gates.Person\n # \u540e\u7eed\u652f\u6301\n # classes_with_members:\n\n\n\n\ncode_dir\n\n\ntemplate_dir\n\n\nbuild_dir\n\n\nrepo_url\n\n\nbranch\n\n\nstyle\n\n\npages\n\n\npage\n\n\ntags\n\n\ntag\n\n\nfunctions\n\n\nclasses\n\n\nclasses_with_methods",
"text": "Configuration\n\n\nA \nsophon.yml\n must contain following information.\n\n\nSimple example of configuration file\n\n\nLet's see an simple example of configuration file.\n\n\nTODO\n\n\n\n\nComplex example of configuration file\n\n\nLet's see an complex example of configuration file.\n\n\nTODO\n\n\n\n\nHierarchy of configuration file\n\n\n# \u6307\u5b9a\u8981\u62bd\u53d6\u7684\u4ee3\u7801\u7684\u6240\u5728\u76ee\u5f55\n# \u8bbe\u7f6e\u8be5\u76ee\u5f55\u7684\u76ee\u7684\u4e3a\u4e86\u4fdd\u8bc1python module\u80fd\u591f\u88ab\u5bfc\u5165\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a.\ncode_dir: .\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\n# \u5982\u679c\u6ca1\u6709\u6a21\u677f\uff0c\u5219\u6240\u6709tag\u5bf9\u5e94\u7684markdown doc\u5bf9\u5e94\u6dfb\u52a0\u5728page\u6587\u4ef6\u672b\u5c3e\ntemplate_dir: templates\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a./api\nbuild_dir:\n\n# \u9700\u8981\u6ce8\u610f\uff0c\u4e0a\u8ff0\u4e24\u4e2a\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u7edd\u5bf9\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u76f8\u5bf9\u8def\u5f84\n# \u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\uff0c\u5219\u662f\u76f8\u5bf9\u4e8e\u672c\u914d\u7f6e\u6587\u4ef6\u800c\u8a00\n\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\npages:\n\n# \u5982\u679c\u6709page\uff0c\u5219\u5728build_dir/\u4e0b\u751f\u6210\u540d\u4e3apage\u7684\u6587\u4ef6\n- page: index.md\n\n- page: user/bb.md # build_dir/user/bb.md\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u5219\u4f7f\u7528\u6a21\u677f\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u800ctemplate_dir\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u4f46\u6a21\u677f\u6587\u4ef6\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u5219\u4e0d\u7528\u6a21\u677f\uff0c\u5373\u521b\u5efa\u7a7a\u767dpage\u7136\u540e\u6dfb\u52a0doc\u5230\u6587\u4ef6\u672b\u5c3e\n template: user/bb.md # template_dir/user/bb.md\n\n\n- page: cc.md\n template: cc_temp.md\n # \u5982\u679c\u6ca1\u6709tags\uff0c\u5219\u4e0d\u4ece\u4ee3\u7801\u4e2d\u751f\u6210markdown\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u6a21\u677f\u6587\u4ef6\u7684\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u7a7a\n # \u5982\u679c\u6709tags\uff0c\u5219\u5bf9\u6bcf\u4e2atag\u751f\u6210markdown\n # \u5982\u679c\u6307\u5b9a\u4e86template\uff0c\u5219\u5c06template\u6587\u4ef6\u4e2d\u7684\u6bcf\u4e2a{{tag\u6807\u8bb0}}\u7f6e\u6362\u4e3a\u5bf9\u5e94\u7684markdown\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9atemplate\uff0ctags\u7684\u4f4d\u7f6e\u4f5c\u7528\u5931\u6548\uff0c\u6240\u6709markdown\u6dfb\u52a0\u5230\u6587\u4ef6\u672b\u5c3e\n tags:\n # \u6bcf\u4e00\u4e2atag\u90fd\u6709\u4e00\u4e2atag\u540d\uff0c\u7528\u4e8e\u8868\u793adoc\u5728\u6587\u4ef6\u4e2d\u7684\u4f4d\u7f6e\n # \u5982\u679c\u6709tag\u540d\uff0c\u5219\u7f6e\u6362{{tag}}\u4e3amarkdown\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709tag\u540d\uff0c\u5219\u751f\u6210\u7684doc\u6dfb\u52a0\u5728page\u7684\u672b\u5c3e\n # \u5982\u679ctag\u5185\u5bb9\u4e3a\u7a7a\uff0c\u5219\u8868\u793amarkdown doc\u4e3a\u7a7a\u5b57\u7b26\u4e32''\n\n - tag: tag1\n # \u6bcf\u4e2atag\u7684doc\u751f\u6210\u987a\u5e8f\u5e76\u4e0d\u662ftag\u5185\u90e8\u51b3\u5b9a\uff0c\u800c\u662fclasses-\nclasses_with_members-\nfunctions\n functions:\n - sss.gates.foo\n - tag: tag2\n classes:\n - sss.gates.Dense\n - sss.gates.Person\n # \u540e\u7eed\u652f\u6301\n # classes_with_members:\n\n\n\n\ncode_dir\n\n\ntemplate_dir\n\n\nbuild_dir\n\n\nrepo_url\n\n\nbranch\n\n\nstyle\n\n\npages\n\n\npage\n\n\ntags\n\n\ntag\n\n\nfunctions\n\n\nclasses\n\n\nclasses_with_methods",
"title": "Configuration"
},
{
"location": "/user_guide/configuration/#configuration",
"text": "A sophon.yml must contain following information. # \u6307\u5b9a\u8981\u62bd\u53d6\u7684\u4ee3\u7801\u7684\u6240\u5728\u76ee\u5f55\n# \u8bbe\u7f6e\u8be5\u76ee\u5f55\u7684\u76ee\u7684\u4e3a\u4e86\u4fdd\u8bc1python module\u80fd\u591f\u88ab\u5bfc\u5165\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a.\ncode_dir: .\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\n# \u5982\u679c\u6ca1\u6709\u6a21\u677f\uff0c\u5219\u6240\u6709tag\u5bf9\u5e94\u7684markdown doc\u5bf9\u5e94\u6dfb\u52a0\u5728page\u6587\u4ef6\u672b\u5c3e\ntemplate_dir: templates\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a./api\nbuild_dir:\n\n# \u9700\u8981\u6ce8\u610f\uff0c\u4e0a\u8ff0\u4e24\u4e2a\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u7edd\u5bf9\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u76f8\u5bf9\u8def\u5f84\n# \u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\uff0c\u5219\u662f\u76f8\u5bf9\u4e8e\u672c\u914d\u7f6e\u6587\u4ef6\u800c\u8a00\n\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\npages:\n\n# \u5982\u679c\u6709page\uff0c\u5219\u5728build_dir/\u4e0b\u751f\u6210\u540d\u4e3apage\u7684\u6587\u4ef6\n- page: index.md\n\n- page: user/bb.md # build_dir/user/bb.md\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u5219\u4f7f\u7528\u6a21\u677f\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u800ctemplate_dir\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u4f46\u6a21\u677f\u6587\u4ef6\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u5219\u4e0d\u7528\u6a21\u677f\uff0c\u5373\u521b\u5efa\u7a7a\u767dpage\u7136\u540e\u6dfb\u52a0doc\u5230\u6587\u4ef6\u672b\u5c3e\n template: user/bb.md # template_dir/user/bb.md\n\n\n- page: cc.md\n template: cc_temp.md\n # \u5982\u679c\u6ca1\u6709tags\uff0c\u5219\u4e0d\u4ece\u4ee3\u7801\u4e2d\u751f\u6210markdown\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u6a21\u677f\u6587\u4ef6\u7684\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u7a7a\n # \u5982\u679c\u6709tags\uff0c\u5219\u5bf9\u6bcf\u4e2atag\u751f\u6210markdown\n # \u5982\u679c\u6307\u5b9a\u4e86template\uff0c\u5219\u5c06template\u6587\u4ef6\u4e2d\u7684\u6bcf\u4e2a{{tag\u6807\u8bb0}}\u7f6e\u6362\u4e3a\u5bf9\u5e94\u7684markdown\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9atemplate\uff0ctags\u7684\u4f4d\u7f6e\u4f5c\u7528\u5931\u6548\uff0c\u6240\u6709markdown\u6dfb\u52a0\u5230\u6587\u4ef6\u672b\u5c3e\n tags:\n # \u6bcf\u4e00\u4e2atag\u90fd\u6709\u4e00\u4e2atag\u540d\uff0c\u7528\u4e8e\u8868\u793adoc\u5728\u6587\u4ef6\u4e2d\u7684\u4f4d\u7f6e\n # \u5982\u679c\u6709tag\u540d\uff0c\u5219\u7f6e\u6362{{tag}}\u4e3amarkdown\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709tag\u540d\uff0c\u5219\u751f\u6210\u7684doc\u6dfb\u52a0\u5728page\u7684\u672b\u5c3e\n # \u5982\u679ctag\u5185\u5bb9\u4e3a\u7a7a\uff0c\u5219\u8868\u793amarkdown doc\u4e3a\u7a7a\u5b57\u7b26\u4e32''\n\n - tag: tag1\n # \u6bcf\u4e2atag\u7684doc\u751f\u6210\u987a\u5e8f\u5e76\u4e0d\u662ftag\u5185\u90e8\u51b3\u5b9a\uff0c\u800c\u662fclasses- classes_with_members- functions\n functions:\n - sss.gates.foo\n - tag: tag2\n classes:\n - sss.gates.Dense\n - sss.gates.Person\n # \u540e\u7eed\u652f\u6301\n # classes_with_members:",
"text": "A sophon.yml must contain following information.",
"title": "Configuration"
},
{
"location": "/user_guide/configuration/#simple-example-of-configuration-file",
"text": "Let's see an simple example of configuration file. TODO",
"title": "Simple example of configuration file"
},
{
"location": "/user_guide/configuration/#complex-example-of-configuration-file",
"text": "Let's see an complex example of configuration file. TODO",
"title": "Complex example of configuration file"
},
{
"location": "/user_guide/configuration/#hierarchy-of-configuration-file",
"text": "# \u6307\u5b9a\u8981\u62bd\u53d6\u7684\u4ee3\u7801\u7684\u6240\u5728\u76ee\u5f55\n# \u8bbe\u7f6e\u8be5\u76ee\u5f55\u7684\u76ee\u7684\u4e3a\u4e86\u4fdd\u8bc1python module\u80fd\u591f\u88ab\u5bfc\u5165\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a.\ncode_dir: .\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\n# \u5982\u679c\u6ca1\u6709\u6a21\u677f\uff0c\u5219\u6240\u6709tag\u5bf9\u5e94\u7684markdown doc\u5bf9\u5e94\u6dfb\u52a0\u5728page\u6587\u4ef6\u672b\u5c3e\ntemplate_dir: templates\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3a./api\nbuild_dir:\n\n# \u9700\u8981\u6ce8\u610f\uff0c\u4e0a\u8ff0\u4e24\u4e2a\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u7edd\u5bf9\u8def\u5f84\uff0c\u53ef\u4ee5\u662f\u76f8\u5bf9\u8def\u5f84\n# \u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\uff0c\u5219\u662f\u76f8\u5bf9\u4e8e\u672c\u914d\u7f6e\u6587\u4ef6\u800c\u8a00\n\n\n# \u53ef\u4ee5\u6ca1\u6709\uff0c\u9ed8\u8ba4\u4e3aNone\npages:\n\n# \u5982\u679c\u6709page\uff0c\u5219\u5728build_dir/\u4e0b\u751f\u6210\u540d\u4e3apage\u7684\u6587\u4ef6\n- page: index.md\n\n- page: user/bb.md # build_dir/user/bb.md\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u5219\u4f7f\u7528\u6a21\u677f\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u800ctemplate_dir\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6307\u5b9a\u4e86\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u4e14template_dir\u5b58\u5728\uff0c\u4f46\u6a21\u677f\u6587\u4ef6\u4e0d\u5b58\u5728\uff0c\u5219\u62a5\u9519\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u8be5\u6587\u4ef6\u7684\u6a21\u677f\uff0c\u5219\u4e0d\u7528\u6a21\u677f\uff0c\u5373\u521b\u5efa\u7a7a\u767dpage\u7136\u540e\u6dfb\u52a0doc\u5230\u6587\u4ef6\u672b\u5c3e\n template: user/bb.md # template_dir/user/bb.md\n\n\n- page: cc.md\n template: cc_temp.md\n # \u5982\u679c\u6ca1\u6709tags\uff0c\u5219\u4e0d\u4ece\u4ee3\u7801\u4e2d\u751f\u6210markdown\u3002\n # \u5982\u679c\u6307\u5b9a\u4e86\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u6a21\u677f\u6587\u4ef6\u7684\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9a\u6a21\u677f\u6587\u4ef6\uff0c\u5219page\u5185\u5bb9\u4e3a\u7a7a\n # \u5982\u679c\u6709tags\uff0c\u5219\u5bf9\u6bcf\u4e2atag\u751f\u6210markdown\n # \u5982\u679c\u6307\u5b9a\u4e86template\uff0c\u5219\u5c06template\u6587\u4ef6\u4e2d\u7684\u6bcf\u4e2a{{tag\u6807\u8bb0}}\u7f6e\u6362\u4e3a\u5bf9\u5e94\u7684markdown\n # \u5982\u679c\u6ca1\u6709\u6307\u5b9atemplate\uff0ctags\u7684\u4f4d\u7f6e\u4f5c\u7528\u5931\u6548\uff0c\u6240\u6709markdown\u6dfb\u52a0\u5230\u6587\u4ef6\u672b\u5c3e\n tags:\n # \u6bcf\u4e00\u4e2atag\u90fd\u6709\u4e00\u4e2atag\u540d\uff0c\u7528\u4e8e\u8868\u793adoc\u5728\u6587\u4ef6\u4e2d\u7684\u4f4d\u7f6e\n # \u5982\u679c\u6709tag\u540d\uff0c\u5219\u7f6e\u6362{{tag}}\u4e3amarkdown\u5185\u5bb9\n # \u5982\u679c\u6ca1\u6709tag\u540d\uff0c\u5219\u751f\u6210\u7684doc\u6dfb\u52a0\u5728page\u7684\u672b\u5c3e\n # \u5982\u679ctag\u5185\u5bb9\u4e3a\u7a7a\uff0c\u5219\u8868\u793amarkdown doc\u4e3a\u7a7a\u5b57\u7b26\u4e32''\n\n - tag: tag1\n # \u6bcf\u4e2atag\u7684doc\u751f\u6210\u987a\u5e8f\u5e76\u4e0d\u662ftag\u5185\u90e8\u51b3\u5b9a\uff0c\u800c\u662fclasses- classes_with_members- functions\n functions:\n - sss.gates.foo\n - tag: tag2\n classes:\n - sss.gates.Dense\n - sss.gates.Person\n # \u540e\u7eed\u652f\u6301\n # classes_with_members:",
"title": "Hierarchy of configuration file"
},
{
"location": "/user_guide/configuration/#code_dir",
"text": "",
Expand Down
18 changes: 9 additions & 9 deletions docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<url>
<loc>None/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

Expand All @@ -13,25 +13,25 @@

<url>
<loc>None/user_guide/installation/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

<url>
<loc>None/user_guide/getting_started/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

<url>
<loc>None/user_guide/sophon_style_python_docstrings/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

<url>
<loc>None/user_guide/configuration/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

Expand All @@ -41,19 +41,19 @@

<url>
<loc>None/about/release_notes/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

<url>
<loc>None/about/contributing/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

<url>
<loc>None/about/license/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

Expand All @@ -62,7 +62,7 @@

<url>
<loc>None/api/sophon/API/</loc>
<lastmod>2016-11-27</lastmod>
<lastmod>2016-11-28</lastmod>
<changefreq>daily</changefreq>
</url>

Expand Down
37 changes: 14 additions & 23 deletions docs/user_guide/configuration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,31 +152,11 @@

<li class="main active"><a href="#configuration">Configuration</a></li>

<li><a href="#code_dir">code_dir</a></li>
<li><a href="#simple-example-of-configuration-file">Simple example of configuration file</a></li>

<li><a href="#template_dir">template_dir</a></li>
<li><a href="#complex-example-of-configuration-file">Complex example of configuration file</a></li>

<li><a href="#build_dir">build_dir</a></li>

<li><a href="#repo_url">repo_url</a></li>

<li><a href="#branch">branch</a></li>

<li><a href="#style">style</a></li>

<li><a href="#pages">pages</a></li>

<li><a href="#page">page</a></li>

<li><a href="#tags">tags</a></li>

<li><a href="#tag">tag</a></li>

<li><a href="#functions">functions</a></li>

<li><a href="#classes">classes</a></li>

<li><a href="#classes_with_methods">classes_with_methods</a></li>
<li><a href="#hierarchy-of-configuration-file">Hierarchy of configuration file</a></li>


</ul>
Expand All @@ -185,6 +165,17 @@

<h1 id="configuration">Configuration</h1>
<p>A <code>sophon.yml</code> must contain following information.</p>
<h2 id="simple-example-of-configuration-file">Simple example of configuration file</h2>
<p>Let's see an simple example of configuration file.</p>
<pre><code>TODO
</code></pre>

<h2 id="complex-example-of-configuration-file">Complex example of configuration file</h2>
<p>Let's see an complex example of configuration file.</p>
<pre><code>TODO
</code></pre>

<h2 id="hierarchy-of-configuration-file">Hierarchy of configuration file</h2>
<pre><code># 指定要抽取的代码的所在目录
# 设置该目录的目的为了保证python module能够被导入
# 可以没有，默认为.
Expand Down
19 changes: 18 additions & 1 deletion mddocs/user_guide/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
A `sophon.yml` must contain following information.


## Simple example of configuration file

Let's see an simple example of configuration file.

```
TODO
```

## Complex example of configuration file

Let's see an complex example of configuration file.

```
TODO
```

## Hierarchy of configuration file

```
# 指定要抽取的代码的所在目录
# 设置该目录的目的为了保证python module能够被导入
Expand Down Expand Up @@ -60,7 +78,6 @@ pages:
# classes_with_members:
```


### code_dir
### template_dir
### build_dir
Expand Down

0 comments on commit fd8e006

Please sign in to comment.