Skip to content

Commit

Permalink
chore: Update npm dependencies and add typedoc configuration files
Browse files Browse the repository at this point in the history
  • Loading branch information
JakubAndrysek committed Jul 3, 2024
1 parent fd4372e commit 51f6350
Show file tree
Hide file tree
Showing 6 changed files with 220 additions and 17 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,6 @@ site/

# ignore large photos: mkdocs-resize-images
assets-large
.resize-hash
.resize-hash

node_modules/
32 changes: 16 additions & 16 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ site_description: >-
repo_name: RoboticsBrno/Robutek
repo_url: https://github.com/RoboticsBrno/Robutek

# Copyright
# copyright: Copyright © RoboticsBrno
dev_addr: "127.0.0.1:8001"
copyright: Copyright © RoboticsBrno
use_directory_urls: True

theme:
Expand Down Expand Up @@ -73,21 +73,21 @@ plugins:
enable_cache: True
size: [1000, 800]
extensions: [".jpg", ".jpeg", ".png", ".gif"]
# - typedoc:
# source: "./docs/elks/lekce1/example1/@types/*.d.ts"
# output_dir: "jaculusApi"
# tsconfig: "./docs/elks/lekce1/example1/tsconfig.json"
# options: "typedoc.json"
# name: "Jaculus API documentation"
- typedoc:
source: "./docs/robot/lekce1/example1/@types/*.d.ts"
output_dir: "jaculusApi"
tsconfig: "./docs/robot/lekce1/example1/tsconfig.json"
options: "typedoc.json"
name: "Jaculus API documentation"

# - zip_folders:
# folders:
# - robot/lekce1/example1
# - robot/lekce3/project3
# - robot/lekce4/project4
# - robot/lekce6/project6
# - robot/lekce8/project8
# debug: true
- zip_folders:
folders:
- robot/lekce1/example1
- robot/lekce3/project3
- robot/lekce4/project4
- robot/lekce6/project6
- robot/lekce8/project8
debug: true

- auto-refresh-build-pages:
update_message: "Návod byl aktualizován, chcete načíst novou verzi?"
Expand Down
176 changes: 176 additions & 0 deletions package-lock.json

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

6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"devDependencies": {
"typedoc": "^0.26.3",
"typescript": "^5.5.3"
}
}
6 changes: 6 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
// this configuration is not possible to pass through the CLI
"navigationLinks": {
"Zpět na dokumentaci": "/"
},
}
13 changes: 13 additions & 0 deletions updates_types.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/bin/bash

if [ "$#" != "1" ] || [ ! -d "$1/ts-examples/@types" ]; then
echo "Run this as $0 PATH_TO_JACULUS_REPO_ROOT"
exit 1
fi

SRC_DIR="$1/ts-examples/@types"

for type_dir in $(find . -type d -name '@types'); do
echo $type_dir
cp -a "$SRC_DIR/"* "$type_dir/"
done

0 comments on commit 51f6350

Please sign in to comment.