Skip to content

Commit

Permalink
add option to generate pdf using 'docfx --serve docfx-pdf.json' and a…
Browse files Browse the repository at this point in the history
…dd pdf to package.
  • Loading branch information
julienkay committed Dec 21, 2023
1 parent 3b6a7b4 commit 94540bc
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*.onnx filter=lfs diff=lfs merge=lfs -text
*.onnx filter=lfs diff=lfs merge=lfs -text
*.pdf filter=lfs diff=lfs merge=lfs -text
Binary file added com.doji.midas/com.doji.midas.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions com.doji.midas/com.doji.midas.pdf.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion com.doji.midas/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"email": "[email protected]",
"url": "https://www.doji-tech.com/"
},
"documentationUrl": "https://www.doji-tech.com/midas/",
"documentationUrl": "https://docs.doji-tech.com/com.doji.midas/",
"samples": [
{
"displayName": "Shared Sample Assets",
Expand Down
6 changes: 3 additions & 3 deletions com.doji.midas/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is a Unity package that allows users to do Monocular Depth Estimation with

## Usage

Please refer to the [documentation] for usage guides.
For usage guides please refer to the [documentation].

[documentation]: https://www.doji-tech.com/midas/
[MiDaS]: https://www.doji-tech.com/midas/
[documentation]: https://docs.doji-tech.com/com.doji.midas/
[MiDaS]: https://github.com/isl-org/MiDaS/
66 changes: 66 additions & 0 deletions docs/docfx-pdf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"metadata": [
{
"src": [
{ "files": [ "doji.midas.csproj" ], "src": "../projects/Midas" }
],
"dest": "api",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"noRestore": false,
"namespaceLayout": "flattened",
"memberLayout": "samePage",
"EnumSortOrder": "declaringOrder",
"allowCompilationErrors": false,
"globalNamespaceId": "Global",
"filter": "filterConfig.yml"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"manual/**.md",
"manual/**/toc.yml",
"toc.yml",
"*.md"
]
},
{ "files": [ "pdf/toc.yml" ] }
],
"resource": [
{
"files": [
"images/**",
]
}
],
"output": "_site",
"globalMetadataFiles": [],
"globalMetadata": {
"_appFaviconPath": "images/favicon.ico",
"_appLogoPath": "images/doji.png",
"_appLogoUrl": "https://www.doji-tech.com/",
"_disableContribution": true,
"pdf": true,
"pdfTocPage": true,
"pdfFileName": "com.doji.midas.pdf"
},
"fileMetadataFiles": [],
"template": [
"default",
"modern",
"template"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
}
}
2 changes: 1 addition & 1 deletion docs/manual/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ A simple example on how to use the library can also be found in the 'Basic Sampl

## Choosing a Model Type

Use the ModelType property to set the desired Midas model. Default is midas_v21_small_256.
Use the ModelType property to set the desired Midas model. Default is @Midas.ModelType.midas_v21_small_256.

```CSharp
var midas = new Midas(ModelType.dpt_beit_large_384);
Expand Down
6 changes: 6 additions & 0 deletions docs/pdf/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
order: 200
items:
- name: Manual
href: ../manual/toc.yml
- name: Scripting API
href: ../api/toc.yml

0 comments on commit 94540bc

Please sign in to comment.