This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-dotpulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 9bce6e9 docs: support API docs (#153)
9bce6e9 is described below
commit 9bce6e9c712a54f6d33481cc8cf54c5d5502c16a
Author: tison <wander4...@gmail.com>
AuthorDate: Fri May 26 11:18:17 2023 +0800
docs: support API docs (#153)
Signed-off-by: tison <wander4...@gmail.com>
---
.github/workflows/ci-unit.yaml | 19 ++++++++++---
.gitignore | 10 ++++++-
README.md | 2 +-
api/.gitignore | 5 ++++
api/index.md | 3 +++
assets/favicon.ico | Bin 0 -> 15086 bytes
assets/pulsar.svg | 12 +++++++++
docfx.json | 60 +++++++++++++++++++++++++++++++++++++++++
index.md | 1 +
toc.yml | 3 +++
10 files changed, 109 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/ci-unit.yaml b/.github/workflows/ci-unit.yaml
index 41f807c..28f7f4a 100644
--- a/.github/workflows/ci-unit.yaml
+++ b/.github/workflows/ci-unit.yaml
@@ -31,9 +31,7 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 120
steps:
- - name: checkout
- uses: actions/checkout@main
-
+ - uses: actions/checkout@v3
- name: Setup dotnet
uses: actions/setup-dotnet@v2
with:
@@ -51,8 +49,21 @@ jobs:
zip -r artifacts.zip artifacts
- name: upload artifacts
- uses: actions/upload-artifact@master
+ uses: actions/upload-artifact@v3
if: failure()
with:
name: artifacts
path: artifacts.zip
+
+ doc-tests:
+ runs-on: ubuntu-latest
+ timeout-minutes: 120
+ steps:
+ - uses: actions/checkout@v3
+ - name: Setup dotnet
+ uses: actions/setup-dotnet@v2
+ with:
+ dotnet-version: '7.0.x'
+ - run: dotnet tool update -g docfx
+ - run: dotnet restore
+ - run: docfx docfx.json
diff --git a/.gitignore b/.gitignore
index abe8c84..9059210 100644
--- a/.gitignore
+++ b/.gitignore
@@ -290,4 +290,12 @@ Temporary Items
# VSCode
.devcontainer
-.vscode
\ No newline at end of file
+.vscode
+
+# docfx
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/README.md b/README.md
index 39525f9..fc34b28 100644
--- a/README.md
+++ b/README.md
@@ -107,4 +107,4 @@ If your contribution adds Pulsar features for C# clients,
you need to update bot
## License
-This project is licensed under the Apache License Version 2.0 - see the
[LICENSE](LICENSE) file for details.
+This project is licensed under [Apache License, Version
2.0](https://apache.org/licenses/LICENSE-2.0).
diff --git a/api/.gitignore b/api/.gitignore
new file mode 100644
index 0000000..e8079a3
--- /dev/null
+++ b/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+# temp file #
+###############
+*.yml
+.manifest
diff --git a/api/index.md b/api/index.md
new file mode 100644
index 0000000..39c888f
--- /dev/null
+++ b/api/index.md
@@ -0,0 +1,3 @@
+# API Documentation
+
+This page hosts the API documentation of DotPulsar.
diff --git a/assets/favicon.ico b/assets/favicon.ico
new file mode 100644
index 0000000..80aa08d
Binary files /dev/null and b/assets/favicon.ico differ
diff --git a/assets/pulsar.svg b/assets/pulsar.svg
new file mode 100644
index 0000000..92e035c
--- /dev/null
+++ b/assets/pulsar.svg
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg";
xmlns:xlink="http://www.w3.org/1999/xlink"; width="134px" height="26px"
viewBox="0 0 134 26" version="1.1">
+<g id="surface1">
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(9.411765%,56.078431%,100%);fill-opacity:1;"
d="M 36.582031 8.285156 L 27.640625 8.285156 C 25.222656 3.621094 22.667969 0
19.191406 0 C 14.664062 0 12.535156 3.976562 10.476562 7.847656 L 10.296875
8.183594 L 0 8.183594 L 0 10.484375 L 5.996094 10.484375 C 8.113281 10.484375
8.546875 11.203125 8.546875 11.203125 C 6.882812 13.796875 4.886719 16.359375
1.558594 16.359375 L 0 16.359375 L 0 18.773438 L 1.570312 18.773438 C 8.023438
18.773 [...]
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 47.875 8.269531 L 41.644531 8.269531 L 41.644531 10.527344 L 47.738281
10.527344 C 50.257812 10.527344 51.703125 11.679688 51.703125 13.742188 C
51.703125 15.699219 50.105469 16.957031 47.640625 16.957031 L 41.644531
16.957031 L 41.644531 24.804688 L 44.042969 24.804688 L 44.042969 19.191406 L
47.597656 19.191406 C 50.851562 19.191406 54.125 17.484375 54.125 13.628906 C
54.105469 10 [...]
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 67.953125 17.847656 C 67.953125 21.050781 66.359375 22.816406 63.46875
22.816406 C 60.578125 22.816406 58.910156 20.964844 58.910156 17.730469 L
58.910156 8.269531 L 56.511719 8.269531 L 56.511719 17.847656 C 56.511719
22.304688 59.148438 25.085938 63.402344 25.085938 C 67.652344 25.085938
70.335938 22.328125 70.335938 17.707031 L 70.335938 8.269531 L 67.9375 8.269531
Z M 67.953125 [...]
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 76.363281 8.269531 L 73.980469 8.269531 L 73.980469 24.828125 L 85.292969
24.828125 L 85.292969 22.566406 L 76.363281 22.566406 Z M 76.363281 8.269531 "/>
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 93.96875 15.390625 C 90.527344 14.648438 89.898438 13.863281 89.898438
12.53125 C 89.898438 11.195312 91.15625 10.261719 92.957031 10.261719 C
94.570312 10.261719 96.132812 10.855469 97.34375 11.925781 L 97.585938
12.117188 L 99 10.261719 L 98.777344 10.078125 C 97.171875 8.710938 95.121094
7.988281 93.015625 8.050781 C 89.824219 8.050781 87.511719 10.007812 87.511719
12.753906 C 87 [...]
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 108.0625 8.152344 L 100.566406 24.828125 L 103.046875 24.828125 L
104.933594 20.605469 L 113.183594 20.605469 L 115.042969 24.828125 L 117.617188
24.828125 L 110.121094 8.152344 Z M 105.898438 18.414062 L 109.070312 11.292969
L 112.222656 18.414062 Z M 105.898438 18.414062 "/>
+<path style="
stroke:none;fill-rule:nonzero;fill:rgb(27.45098%,30.588235%,33.72549%);fill-opacity:1;"
d="M 129.046875 18.195312 C 131.617188 17.59375 133.136719 15.78125 133.136719
13.300781 C 133.164062 12.050781 132.691406 10.84375 131.828125 9.945312 C
130.535156 8.78125 128.839844 8.179688 127.109375 8.261719 L 119.992188
8.261719 L 119.992188 24.828125 L 122.390625 24.828125 L 122.390625 18.617188 L
126.480469 18.617188 L 131.078125 24.820312 L 134.019531 24.820312 Z M
122.367188 16 [...]
+</g>
+</svg>
diff --git a/docfx.json b/docfx.json
new file mode 100644
index 0000000..69ad53b
--- /dev/null
+++ b/docfx.json
@@ -0,0 +1,60 @@
+{
+ "metadata": [
+ {
+ "src": [
+ {
+ "files": [
+ "src/DotPulsar/bin/**/*.dll"
+ ]
+ }
+ ],
+ "dest": "api",
+ "includePrivateMembers": false,
+ "disableGitFeatures": false,
+ "disableDefaultFilter": false,
+ "noRestore": false,
+ "namespaceLayout": "flattened",
+ "memberLayout": "samePage",
+ "allowCompilationErrors": false
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "api/**.yml",
+ "api/index.md"
+ ]
+ },
+ {
+ "files": [
+ "toc.yml",
+ "CHANGELOG.md",
+ "CONTRIBUTING.md",
+ "index.md"
+ ]
+ }
+ ],
+ "resource": [
+ {
+ "files": [
+ "assets/**"
+ ]
+ }
+ ],
+ "dest": "_site",
+ "globalMetadata": {
+ "_appTitle": "Official DotPulsar Documentation",
+ "_appFooter": "Copyright © 2019-2023 The Apache Software
Foundation. All Rights Reserved. Apache, Pulsar, Apache Pulsar, and the Apache
feather logo are trademarks or registered trademarks of The Apache Software
Foundation.",
+ "_appLogoPath": "assets/pulsar.svg",
+ "_appFaviconPath": "assets/favicon.ico"
+ },
+ "template": [
+ "default",
+ "modern"
+ ],
+ "postProcessors": [],
+ "keepFileLink": false,
+ "disableGitFeatures": false
+ }
+}
diff --git a/index.md b/index.md
new file mode 120000
index 0000000..42061c0
--- /dev/null
+++ b/index.md
@@ -0,0 +1 @@
+README.md
\ No newline at end of file
diff --git a/toc.yml b/toc.yml
new file mode 100644
index 0000000..fffb014
--- /dev/null
+++ b/toc.yml
@@ -0,0 +1,3 @@
+- name: API
+ href: api/
+ homepage: api/index.md
