From 2c60ac63130d6c80fd4925ebdec3e1967686282f Mon Sep 17 00:00:00 2001 From: Florian Hockmann Date: Wed, 16 Nov 2016 21:01:41 +0100 Subject: [PATCH] Add DocFX documentation project --- doc/.gitignore | 9 ++++++ doc/api/.gitignore | 4 +++ doc/api/.manifest | 1 + doc/docfx.json | 70 ++++++++++++++++++++++++++++++++++++++++++++++ doc/index.md | 2 ++ doc/toc.yml | 3 ++ 6 files changed, 89 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/api/.gitignore create mode 100644 doc/api/.manifest create mode 100644 doc/docfx.json create mode 100644 doc/index.md create mode 100644 doc/toc.yml diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..4378419 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/doc/api/.gitignore b/doc/api/.gitignore new file mode 100644 index 0000000..da7c71b --- /dev/null +++ b/doc/api/.gitignore @@ -0,0 +1,4 @@ +############### +# temp file # +############### +*.yml diff --git a/doc/api/.manifest b/doc/api/.manifest new file mode 100644 index 0000000..5b2bbb0 --- /dev/null +++ b/doc/api/.manifest @@ -0,0 +1 @@ +{"Gremlin.Net":"Gremlin.Net.yml","Gremlin.Net.GremlinClient":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClient.#ctor(Gremlin.Net.GremlinServer)":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClient.NrConnections":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClient.SubmitAsync``1(Gremlin.Net.Messages.ScriptRequestMessage)":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClient.Dispose":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClient.Dispose(System.Boolean)":"Gremlin.Net.GremlinClient.yml","Gremlin.Net.GremlinClientExtensions":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinClientExtensions.SubmitWithSingleResultAsync``1(Gremlin.Net.IGremlinClient,System.String,System.Collections.Generic.Dictionary{System.String,System.Object})":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinClientExtensions.SubmitWithSingleResultAsync``1(Gremlin.Net.IGremlinClient,Gremlin.Net.Messages.ScriptRequestMessage)":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinClientExtensions.SubmitAsync(Gremlin.Net.IGremlinClient,System.String,System.Collections.Generic.Dictionary{System.String,System.Object})":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinClientExtensions.SubmitAsync(Gremlin.Net.IGremlinClient,Gremlin.Net.Messages.ScriptRequestMessage)":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinClientExtensions.SubmitAsync``1(Gremlin.Net.IGremlinClient,System.String,System.Collections.Generic.Dictionary{System.String,System.Object})":"Gremlin.Net.GremlinClientExtensions.yml","Gremlin.Net.GremlinServer":"Gremlin.Net.GremlinServer.yml","Gremlin.Net.GremlinServer.#ctor(System.String,System.Int32,System.Boolean)":"Gremlin.Net.GremlinServer.yml","Gremlin.Net.GremlinServer.Uri":"Gremlin.Net.GremlinServer.yml","Gremlin.Net.IGremlinClient":"Gremlin.Net.IGremlinClient.yml","Gremlin.Net.IGremlinClient.SubmitAsync``1(Gremlin.Net.Messages.ScriptRequestMessage)":"Gremlin.Net.IGremlinClient.yml","Gremlin.Net.Exceptions":"Gremlin.Net.Exceptions.yml","Gremlin.Net.Exceptions.ResponseException":"Gremlin.Net.Exceptions.ResponseException.yml","Gremlin.Net.Messages":"Gremlin.Net.Messages.yml","Gremlin.Net.Messages.RequestArguments":"Gremlin.Net.Messages.RequestArguments.yml","Gremlin.Net.Messages.RequestArguments.BatchSize":"Gremlin.Net.Messages.RequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments.GremlinScript":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments.Bindings":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments.Language":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments.Aliases":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestArguments.ScriptEvaluationTimeoutInMs":"Gremlin.Net.Messages.ScriptRequestArguments.yml","Gremlin.Net.Messages.ScriptRequestMessage":"Gremlin.Net.Messages.ScriptRequestMessage.yml","Gremlin.Net.Messages.ScriptRequestMessage.RequestId":"Gremlin.Net.Messages.ScriptRequestMessage.yml","Gremlin.Net.Messages.ScriptRequestMessage.Operation":"Gremlin.Net.Messages.ScriptRequestMessage.yml","Gremlin.Net.Messages.ScriptRequestMessage.Processor":"Gremlin.Net.Messages.ScriptRequestMessage.yml","Gremlin.Net.Messages.ScriptRequestMessage.Arguments":"Gremlin.Net.Messages.ScriptRequestMessage.yml"} \ No newline at end of file diff --git a/doc/docfx.json b/doc/docfx.json new file mode 100644 index 0000000..6d7d678 --- /dev/null +++ b/doc/docfx.json @@ -0,0 +1,70 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "**/project.json" + ], + "exclude": [ + "**/obj/**", + "**/bin/**" + ], + "src": "../src" + } + ], + "dest": "api" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ], + "dest": "." + }, + { + "files": [ + "toc.yml", + "*.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "postProcessors": [], + "noLangKeyword": false + } +} \ No newline at end of file diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..9c9ea55 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,2 @@ +# Gremlin.Net API Documentation. +Here you can find the API documentation of [Gremlin.Net](https://github.com/FlorianHockmann/Gremlin.Net). diff --git a/doc/toc.yml b/doc/toc.yml new file mode 100644 index 0000000..4306148 --- /dev/null +++ b/doc/toc.yml @@ -0,0 +1,3 @@ +- name: Api Documentation + href: api/ + homepage: api/Gremlin.Net.yml