Skip to content
This repository has been archived by the owner on Sep 20, 2019. It is now read-only.

Commit

Permalink
Add DocFX documentation project
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianHockmann committed Nov 16, 2016
1 parent 68f8f15 commit 2c60ac6
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
4 changes: 4 additions & 0 deletions doc/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
###############
# temp file #
###############
*.yml
1 change: 1 addition & 0 deletions doc/api/.manifest
Original file line number Diff line number Diff line change
@@ -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"}
70 changes: 70 additions & 0 deletions doc/docfx.json
Original file line number Diff line number Diff line change
@@ -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
}
}
2 changes: 2 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Gremlin.Net API Documentation.
Here you can find the API documentation of [Gremlin.Net](https://github.com/FlorianHockmann/Gremlin.Net).
3 changes: 3 additions & 0 deletions doc/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- name: Api Documentation
href: api/
homepage: api/Gremlin.Net.yml

0 comments on commit 2c60ac6

Please sign in to comment.