add doc build workflow

Author: quinchs

.github/workflows/build-docs-pr.yml

@@ -0,0 +1,27 @@
+name: Docs Build (PR)
+
+on:
+  - pull_request
+
+env: 
+  BuildNumber: "${{ github.run_number }}"
+
+jobs:
+  publish-prerelease:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 6.0.x
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build --no-restore
+
+    - name: Doc generation
+      run: dotnet run --project  ./tools/EdgeDB.DocGenerator/ -- $GITHUB_WORKSPACE

.github/workflows/build-docs-push.yml

@@ -0,0 +1,28 @@
+name: Docs Build (push)
+
+on:
+  push:
+    branches: [ dev ]
+
+env: 
+  BuildNumber: "${{ github.run_number }}"
+
+jobs:
+  publish-prerelease:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 6.0.x
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build --no-restore
+
+    - name: Doc generation
+      run: dotnet run --project  ./tools/EdgeDB.DocGenerator/ -- $GITHUB_WORKSPACE

.gitignore

@@ -379,3 +379,4 @@ MigrationBackup/
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
 src/EdgeDB.ExampleApp/dump.db
+docs/tmp/*

docs/api.rst

@@ -2099,22 +2099,6 @@ API Documentation
             :param T:
                 The inner type of the optional.
 
-        .. dn:method::  Create<T, T2>(T value, T2 other): Optional<T>
-
-            Creates a fuckign optionalll 
-
-            :param T value:
-                aaa
-
-            :param T2 other:
-                aaa
-
-            :param T:
-                The inner type of the optional.
-
-            :param T2:
-                The 2nd
-
         .. dn:method::  ToNullable<T>(this Optional<T> val): T?
 
             Converts the :dn:class:`EdgeDB.Optional<T>` to a ``System.Nullable`1``. 

docs/exceptions.rst

@@ -4,8 +4,6 @@
 Exceptions
 ==========
 
-.. _edgedb-dotnet-api-edgedb.configurationexception:
-
 .. dn:class:: EdgeDB.ConfigurationException
 
     Represents a generic configuration error. 
@@ -28,8 +26,6 @@ Exceptions
         :param Exception inner:
             An inner exception.
 
-.. _edgedb-dotnet-api-edgedb.connectionfailedexception:
-
 .. dn:class:: EdgeDB.ConnectionFailedException
 
     Represents a connection failure that cannot be retried. 
@@ -46,8 +42,6 @@ Exceptions
         :param int attempts:
             The number of attempts made to connect.
 
-.. _edgedb-dotnet-api-edgedb.connectionfailedtemporarilyexception:
-
 .. dn:class:: EdgeDB.ConnectionFailedTemporarilyException
 
     Represents a temporary connection failiure exception. 
@@ -64,8 +58,6 @@ Exceptions
         :param SocketError error:
             The underlying socket error that caused this exception to be thrown.
 
-.. _edgedb-dotnet-api-edgedb.customclientexception:
-
 .. dn:class:: EdgeDB.CustomClientException
 
     Represents a generic error with custom clients. 
@@ -78,8 +70,6 @@ Exceptions
         :param string message:
             The error message describing why this exception was thrown.
 
-.. _edgedb-dotnet-api-edgedb.edgedberrorexception:
-
 .. dn:class:: EdgeDB.EdgeDBErrorException
 
     Represents an exception that was caused by an error from EdgeDB. 
@@ -105,8 +95,6 @@ Exceptions
 
         Prettifies the error if it was a result of a bad query string; otherwise formats it. 
 
-.. _edgedb-dotnet-api-edgedb.edgedbexception:
-
 .. dn:class:: EdgeDB.EdgeDBException
 
     Represents a generic exception that occured with the edgedb library. 
@@ -151,8 +139,6 @@ Exceptions
         :param Boolean shouldReconnect:
             Whether or not the client who caught this exception should reconnect.
 
-.. _edgedb-dotnet-api-edgedb.invalidconnectionexception:
-
 .. dn:class:: EdgeDB.InvalidConnectionException
 
     Represents an error with the provided connection details. 
@@ -165,8 +151,6 @@ Exceptions
         :param string message:
             The error message describing why this exception was thrown.
 
-.. _edgedb-dotnet-api-edgedb.invalidsignatureexception:
-
 .. dn:class:: EdgeDB.InvalidSignatureException
 
     Represents an exception that occurs when the server signature is incorrect. 
@@ -176,8 +160,6 @@ Exceptions
 
         Constructs a new :dn:class:`EdgeDB.InvalidSignatureException`. 
 
-.. _edgedb-dotnet-api-edgedb.missingcodecexception:
-
 .. dn:class:: EdgeDB.MissingCodecException
 
     Represents an exception that occurs when the client doesn't have a codec for incoming or outgoing data. 
@@ -190,8 +172,6 @@ Exceptions
         :param string message:
             The error message describing why this exception was thrown.
 
-.. _edgedb-dotnet-api-edgedb.missingrequiredexception:
-
 .. dn:class:: EdgeDB.MissingRequiredException
 
     Represents an exception that occurs when required data isn't returned. 
@@ -201,8 +181,6 @@ Exceptions
 
         Constructs a new :dn:class:`EdgeDB.MissingRequiredException`. 
 
-.. _edgedb-dotnet-api-edgedb.notypeconverterexception:
-
 .. dn:class:: EdgeDB.NoTypeConverterException
 
     Represents an exception thrown when no type converter could be found. 
@@ -241,8 +219,6 @@ Exceptions
         :param Exception inner:
             An optional inner exception.
 
-.. _edgedb-dotnet-api-edgedb.resultcardinalitymismatchexception:
-
 .. dn:class:: EdgeDB.ResultCardinalityMismatchException
 
     Represents an exception that occurs when a queries cardinality isn't what the client was expecting. 
@@ -258,8 +234,6 @@ Exceptions
         :param Cardinality actual:
             The actual cardinality
 
-.. _edgedb-dotnet-api-edgedb.transactionexception:
-
 .. dn:class:: EdgeDB.TransactionException
 
     Represents an exception that occurs within transactions. 
@@ -275,8 +249,6 @@ Exceptions
         :param Exception innerException:
             An optional inner exception.
 
-.. _edgedb-dotnet-api-edgedb.unexpectedmessageexception:
-
 .. dn:class:: EdgeDB.UnexpectedMessageException
 
     Represents an exception that occurs when the client receives an unexpected message.