From 6acb3fb037f34d4628fb2aa98204c84b7ac5a73f Mon Sep 17 00:00:00 2001 From: Paolo Pustorino Date: Mon, 11 Mar 2024 15:44:28 +0100 Subject: [PATCH] refs #147: base docs framework polishing (#171) * refs #147: Access to Dockerized tools is now proxied by compose. * refs #147: Fixed a WIP make target. * refs #147: Changed folder structure to make docs more self-contained. * refs #147: Typo fix. * refs #147: Renamed container and target for consistency. * refs #147: Got rid of unnecessary nesting in folder structure. Relocated docs README file. * refs #147: Added working deploy target to makefile. The docs can be safely deployed to GH Pages. * refs #147: Added MkDocs metadata for site and github direct editing link. * refs #147: Deploy procedure now forcefully triggers API extraction. README file for docs updated. --- .gitignore | 11 +- Makefile | 40 ---- docker-compose.yml | 14 -- .../scripting-reference/index.md | 4 - .../Dockerfile.DocsExtractor | 2 +- Dockerfile.MkDocs => docs/Dockerfile.MkDocs | 0 docs/Makefile | 33 +++ {docs-src => docs}/README.md | 35 +-- .../dist}/.gitkeep | 0 docs/docker-compose.yml | 23 ++ mkdocs.yml => docs/mkdocs.yml | 12 +- docs/scripts/deploy_to_ghpages | 220 ++++++++++++++++++ .../scripts/generate_reference | 0 .../advanced-animations.md | 0 .../extending-customizing-popochiu.md | 0 .../game-state-saving-loading.md | 0 .../src}/advanced-techniques/guis.md | 0 .../src}/advanced-techniques/index.md | 0 .../src}/advanced-techniques/localization.md | 0 .../src}/assets/css/algolia.css | 0 .../src}/assets/css/custom.css | 0 .../content => docs/src}/assets/css/dev.css | 0 .../assets/css/fonts/JetBrainsMono-Bold.woff2 | Bin .../css/fonts/JetBrainsMono-Medium.woff2 | Bin .../css/fonts/JetBrainsMono-Regular.woff2 | Bin ...e_importer-activate_importer-character.png | Bin ...eprite_importer-activate_importer-room.png | Bin ..._importer-importer_interface-character.png | Bin ..._importer-importer_interface-room-diff.png | Bin ...prite_importer-importer_interface-room.png | Bin .../images/aseprite_importer-settings-es.png | Bin .../images/aseprite_importer-settings-ps.png | Bin ...importer-source_file_example-character.png | Bin ...te_importer-source_file_example-room-1.png | Bin ...te_importer-source_file_example-room-2.png | Bin ...te_importer-source_file_example-room-3.png | Bin .../images/audio_tab-context_not_assigned.png | Bin .../images/audio_tab-context_shared.png | Bin .../src}/assets/images/audio_tab-resource.png | Bin .../assets/images/audio_tab-row_buttons.png | Bin .../src}/assets/images/audio_tab.png | Bin .../images/getting_started-itch_cover.png | Bin .../images/getting_started-popochiu_dock.png | Bin .../getting_started-settings_button.png | Bin .../src}/assets/images/home_cover.png | Bin .../src}/assets/images/icon-400.png | Bin .../src}/assets/images/icon.png | Bin .../src}/assets/images/icon_add_to_core.png | Bin .../assets/images/icon_character-trimmed.png | Bin .../assets/images/icon_dialog-trimmed.png | Bin .../assets/images/icon_hotspot-trimmed.png | Bin .../images/icon_inventory_item-trimmed.png | Bin .../images/icon_inventory_item_start.png | Bin .../src}/assets/images/icon_no_bg-200.png | Bin .../src}/assets/images/icon_no_bg-300.png | Bin .../src}/assets/images/icon_no_bg-400.png | Bin .../src}/assets/images/icon_no_bg-700.png | Bin .../src}/assets/images/icon_no_bg.png | Bin .../assets/images/icon_player_character.png | Bin .../src}/assets/images/icon_point-trimmed.png | Bin .../src}/assets/images/icon_prop-trimmed.png | Bin .../assets/images/icon_region-trimmed.png | Bin .../src}/assets/images/icon_room-trimmed.png | Bin .../images/icon_walkable_area-trimmed.png | Bin .../images/main_tab-context_character.png | Bin .../assets/images/main_tab-context_item.png | Bin .../assets/images/main_tab-context_room.png | Bin .../assets/images/main_tab-context_shared.png | Bin .../assets/images/main_tab-row_buttons.png | Bin .../src}/assets/images/main_tab.png | Bin .../images/popochiu-v1.10_button-en.png | Bin .../images/popochiu-v1.10_button-es.png | Bin .../assets/images/popochiu-v1.9_button-en.png | Bin .../assets/images/popochiu-v1.9_button-es.png | Bin .../images/popochiu-v1.9_thumbnail-en.png | Bin .../images/popochiu-v1.9_thumbnail-es.png | Bin .../src}/assets/images/popochiu_2_hero-en.png | Bin .../src}/assets/images/popochiu_2_hero-es.png | Bin .../src}/assets/images/popochiu_hero-en.png | Bin .../src}/assets/images/popochiu_hero-es.png | Bin .../images/popochiu_list_of_features-en.png | Bin .../images/popochiu_list_of_features-es.png | Bin .../images/popochiu_tutorials_button-en.png | Bin .../images/popochiu_tutorials_button-es.png | Bin .../assets/images/room_tab-context_shared.png | Bin .../src}/assets/images/room_tab-header.png | Bin .../assets/images/room_tab-row_buttons.png | Bin .../src}/assets/images/room_tab.png | Bin .../images/settings-text_continue_mode.png | Bin .../assets/images/settings-text_speeds.png | Bin .../src}/assets/images/settings.png | Bin ...thumbnail-01-create_room_and_character.jpg | Bin .../thumbnail-02-baseline_gap_hotspot.jpg | Bin .../thumbnail-03-prop_inventory_item.jpg | Bin .../images/thumbnail-04-character_dialog.jpg | Bin .../thumbnail-05-dialog_options_use_item.jpg | Bin .../images/thumbnail-06-room_change.jpg | Bin .../assets/images/thumbnail-07-add_audio.jpg | Bin .../content => docs/src}/assets/js/custom.js | 0 .../src}/assets/js/gdscript.min.js | 0 .../coding-standards.md | 0 .../contributing-to-popochiu/getting-help.md | 0 .../src}/contributing-to-popochiu/index.md | 0 .../project-management.md | 0 .../project-overview.md | 0 .../toolchain-and-dependencies.md | 0 .../getting-started/creating-a-game-stub.md | 2 +- .../src}/getting-started/example-resources.md | 0 .../src}/getting-started/getting-help.md | 0 .../src}/getting-started/index.md | 0 .../getting-started/installing-popochiu.md | 0 .../src}/getting-started/tutorials.md | 0 .../how-to-develop-a-game/adding-sound.md | 0 .../creating-characters.md | 0 .../how-to-develop-a-game/creating-rooms.md | 0 .../src}/how-to-develop-a-game/index.md | 0 .../kickstarting-a-project.md | 0 .../managing-the-inventory.md | 0 .../playing-animations.md | 0 .../scripting-interactions.md | 0 .../writing-dialogues.md | 0 {docs-src/content => docs/src}/index.md | 0 .../the-editor-handbook/editor-settings.md | 0 .../src}/the-editor-handbook/importers.md | 0 .../src}/the-editor-handbook/index.md | 0 .../the-editor-handbook/interface-overview.md | 0 .../src}/the-editor-handbook/popochiu-dock.md | 0 .../the-editor-handbook/toolbar-buttons.md | 0 .../src/the-engine-handbook}/.gitkeep | 0 .../src}/the-engine-handbook/index.md | 0 .../the-engine-handbook/scripting-overview.md | 0 .../scripting-reference}/.gitkeep | 0 132 files changed, 313 insertions(+), 83 deletions(-) delete mode 100644 Makefile delete mode 100644 docker-compose.yml delete mode 100644 docs-src/content/the-engine-handbook/scripting-reference/index.md rename Dockerfile.DocsMaker => docs/Dockerfile.DocsExtractor (96%) rename Dockerfile.MkDocs => docs/Dockerfile.MkDocs (100%) create mode 100644 docs/Makefile rename {docs-src => docs}/README.md (68%) rename {docs-src/content/the-engine-handbook => docs/dist}/.gitkeep (100%) create mode 100644 docs/docker-compose.yml rename mkdocs.yml => docs/mkdocs.yml (75%) create mode 100755 docs/scripts/deploy_to_ghpages rename generate_reference => docs/scripts/generate_reference (100%) rename {docs-src/content => docs/src}/advanced-techniques/advanced-animations.md (100%) rename {docs-src/content => docs/src}/advanced-techniques/extending-customizing-popochiu.md (100%) rename {docs-src/content => docs/src}/advanced-techniques/game-state-saving-loading.md (100%) rename {docs-src/content => docs/src}/advanced-techniques/guis.md (100%) rename {docs-src/content => docs/src}/advanced-techniques/index.md (100%) rename {docs-src/content => docs/src}/advanced-techniques/localization.md (100%) rename {docs-src/content => docs/src}/assets/css/algolia.css (100%) rename {docs-src/content => docs/src}/assets/css/custom.css (100%) rename {docs-src/content => docs/src}/assets/css/dev.css (100%) rename {docs-src/content => docs/src}/assets/css/fonts/JetBrainsMono-Bold.woff2 (100%) rename {docs-src/content => docs/src}/assets/css/fonts/JetBrainsMono-Medium.woff2 (100%) rename {docs-src/content => docs/src}/assets/css/fonts/JetBrainsMono-Regular.woff2 (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-activate_importer-character.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-activate_importer-room.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-importer_interface-character.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-importer_interface-room-diff.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-importer_interface-room.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-settings-es.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-settings-ps.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-source_file_example-character.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-source_file_example-room-1.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-source_file_example-room-2.png (100%) rename {docs-src/content => docs/src}/assets/images/aseprite_importer-source_file_example-room-3.png (100%) rename {docs-src/content => docs/src}/assets/images/audio_tab-context_not_assigned.png (100%) rename {docs-src/content => docs/src}/assets/images/audio_tab-context_shared.png (100%) rename {docs-src/content => docs/src}/assets/images/audio_tab-resource.png (100%) rename {docs-src/content => docs/src}/assets/images/audio_tab-row_buttons.png (100%) rename {docs-src/content => docs/src}/assets/images/audio_tab.png (100%) rename {docs-src/content => docs/src}/assets/images/getting_started-itch_cover.png (100%) rename {docs-src/content => docs/src}/assets/images/getting_started-popochiu_dock.png (100%) rename {docs-src/content => docs/src}/assets/images/getting_started-settings_button.png (100%) rename {docs-src/content => docs/src}/assets/images/home_cover.png (100%) rename {docs-src/content => docs/src}/assets/images/icon-400.png (100%) rename {docs-src/content => docs/src}/assets/images/icon.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_add_to_core.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_character-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_dialog-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_hotspot-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_inventory_item-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_inventory_item_start.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_no_bg-200.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_no_bg-300.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_no_bg-400.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_no_bg-700.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_no_bg.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_player_character.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_point-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_prop-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_region-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_room-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/icon_walkable_area-trimmed.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab-context_character.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab-context_item.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab-context_room.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab-context_shared.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab-row_buttons.png (100%) rename {docs-src/content => docs/src}/assets/images/main_tab.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.10_button-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.10_button-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.9_button-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.9_button-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.9_thumbnail-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu-v1.9_thumbnail-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_2_hero-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_2_hero-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_hero-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_hero-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_list_of_features-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_list_of_features-es.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_tutorials_button-en.png (100%) rename {docs-src/content => docs/src}/assets/images/popochiu_tutorials_button-es.png (100%) rename {docs-src/content => docs/src}/assets/images/room_tab-context_shared.png (100%) rename {docs-src/content => docs/src}/assets/images/room_tab-header.png (100%) rename {docs-src/content => docs/src}/assets/images/room_tab-row_buttons.png (100%) rename {docs-src/content => docs/src}/assets/images/room_tab.png (100%) rename {docs-src/content => docs/src}/assets/images/settings-text_continue_mode.png (100%) rename {docs-src/content => docs/src}/assets/images/settings-text_speeds.png (100%) rename {docs-src/content => docs/src}/assets/images/settings.png (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-01-create_room_and_character.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-02-baseline_gap_hotspot.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-03-prop_inventory_item.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-04-character_dialog.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-05-dialog_options_use_item.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-06-room_change.jpg (100%) rename {docs-src/content => docs/src}/assets/images/thumbnail-07-add_audio.jpg (100%) rename {docs-src/content => docs/src}/assets/js/custom.js (100%) rename {docs-src/content => docs/src}/assets/js/gdscript.min.js (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/coding-standards.md (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/getting-help.md (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/index.md (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/project-management.md (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/project-overview.md (100%) rename {docs-src/content => docs/src}/contributing-to-popochiu/toolchain-and-dependencies.md (100%) rename {docs-src/content => docs/src}/getting-started/creating-a-game-stub.md (94%) rename {docs-src/content => docs/src}/getting-started/example-resources.md (100%) rename {docs-src/content => docs/src}/getting-started/getting-help.md (100%) rename {docs-src/content => docs/src}/getting-started/index.md (100%) rename {docs-src/content => docs/src}/getting-started/installing-popochiu.md (100%) rename {docs-src/content => docs/src}/getting-started/tutorials.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/adding-sound.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/creating-characters.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/creating-rooms.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/index.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/kickstarting-a-project.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/managing-the-inventory.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/playing-animations.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/scripting-interactions.md (100%) rename {docs-src/content => docs/src}/how-to-develop-a-game/writing-dialogues.md (100%) rename {docs-src/content => docs/src}/index.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/editor-settings.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/importers.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/index.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/interface-overview.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/popochiu-dock.md (100%) rename {docs-src/content => docs/src}/the-editor-handbook/toolbar-buttons.md (100%) rename {docs-src/content/the-engine-handbook/scripting-reference => docs/src/the-engine-handbook}/.gitkeep (100%) rename {docs-src/content => docs/src}/the-engine-handbook/index.md (100%) rename {docs-src/content => docs/src}/the-engine-handbook/scripting-overview.md (100%) rename docs/{ => src/the-engine-handbook/scripting-reference}/.gitkeep (100%) diff --git a/.gitignore b/.gitignore index af34cf71..817928ba 100644 --- a/.gitignore +++ b/.gitignore @@ -35,9 +35,12 @@ game game/** # Documentation ignores -docs-src/**/*.import -docs-src/**/scripting-reference/*.md -!docs-src/**/scripting-reference/index.md +docs/src/**/*.import +docs/src/**/scripting-reference/*.md +!docs/src/**/scripting-reference/index.md +docs/dist/* +docs/dist/**/* +!docs/dist/.gitkeep Collector*.gd ReferenceCollectorCLI*.gd -reference.json +reference.json \ No newline at end of file diff --git a/Makefile b/Makefile deleted file mode 100644 index 84bbe53b..00000000 --- a/Makefile +++ /dev/null @@ -1,40 +0,0 @@ -CURRENT_UID := $(shell id -u):$(shell id -g) - -all: up - -docs-up: - docker compose pull - docker compose up -d --remove-orphans - -docs-down: - docker compose down - -docs-deploy: - docker run --rm \ - -v ".:/app" \ - -u $(CURRENT_UID) \ - -w /app \ - minidocks/mkdocs gh-deploy --verbose - -gdm-build: - docker build \ - --no-cache \ - --build-arg="DOCKER_USER_UID=$(shell id -u)" \ - --build-arg="DOCKER_USER_GID=$(shell id -g)" \ - -t popochiu-docs-maker:latest \ - -f Dockerfile.DocsMaker . - -gdm-generate: - docker run --rm \ - -v .:/project \ - -v ./docs-src/content/the-engine-handbook/scripting-reference:/output \ - -u $(CURRENT_UID) \ - popochiu-docs-maker:latest /project \ - -o /output \ - -d addons/popochiu/engine/ - -cli: - docker compose run --rm documentation bash - -logs: - docker compose logs -f diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index c5bd82e4..00000000 --- a/docker-compose.yml +++ /dev/null @@ -1,14 +0,0 @@ -version: "3" -services: - documentation: - ports: - - 286:80 - volumes: - - .:/app - working_dir: /app - labels: - - com.dnsdock.alias=docs.popochiu.local - build: - context: . - dockerfile: Dockerfile.MkDocs - command: serve -a 0.0.0.0:80 \ No newline at end of file diff --git a/docs-src/content/the-engine-handbook/scripting-reference/index.md b/docs-src/content/the-engine-handbook/scripting-reference/index.md deleted file mode 100644 index 286a307e..00000000 --- a/docs-src/content/the-engine-handbook/scripting-reference/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -weight: 3020 -empty: true ---- diff --git a/Dockerfile.DocsMaker b/docs/Dockerfile.DocsExtractor similarity index 96% rename from Dockerfile.DocsMaker rename to docs/Dockerfile.DocsExtractor index 9949dcf1..242ab43e 100644 --- a/Dockerfile.DocsMaker +++ b/docs/Dockerfile.DocsExtractor @@ -37,7 +37,7 @@ RUN addgroup --system --gid ${DOCKER_USER_GID} ${DOCKER_USER} \ WORKDIR /app -COPY --chmod=777 generate_reference generate_reference +COPY --chmod=777 scripts/generate_reference generate_reference # Install application dependencies RUN python3 setup.py install diff --git a/Dockerfile.MkDocs b/docs/Dockerfile.MkDocs similarity index 100% rename from Dockerfile.MkDocs rename to docs/Dockerfile.MkDocs diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..8d21b839 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,33 @@ +CURRENT_UID := $(shell id -u):$(shell id -g) + +all: docs-up + +docs-up: + docker compose pull + docker compose up -d --remove-orphans + +docs-down: + docker compose down + +docs-deploy: docs-extract + rm -rf ./dist && git restore dist + docker compose run \ + --rm \ + --user ${CURRENT_UID} \ + documentation \ + mkdocs build --verbose + GIT_DEPLOY_USERNAME="$(shell git config user.name)" GIT_DEPLOY_MAIL="$(shell git config user.email)" scripts/deploy_to_ghpages + +docs-extract: + docker compose run \ + --rm \ + --user $(CURRENT_UID) \ + docs-extractor /project \ + -o /output \ + -d addons/popochiu/engine/ + +cli: + docker compose run --rm documentation bash + +logs: + docker compose logs -f diff --git a/docs-src/README.md b/docs/README.md similarity index 68% rename from docs-src/README.md rename to docs/README.md index a76b2634..3a1fe5e6 100644 --- a/docs-src/README.md +++ b/docs/README.md @@ -76,9 +76,9 @@ About Make, there are different ways to install it: ## Run the documentation -To run the documentation, just enter the project's directory and issue this command: +To run the documentation, just enter the `docs` directory in the project's repository and issue this command: -> `make docs-up' +> `make docs-up` This will start the Docker container, and will bind port 286 of the host to the running instance of MkDocs in the container. To view the docs live in your browser, just visit [http://localhost:286](http://localhost:286). @@ -92,34 +92,39 @@ Please, read the contribution rules before pushing changes to Popochiu Documenta ## How to export scripting reference to the local development environment -Scripting reference is automatically exported by GitHub Actions when the doc is published to production. -Should you want to export the refs locally to preview your work on the docs, a make command is available for that. +Scripting reference ~~is~~ will be automatically exported by GitHub Actions when the doc is published to production. -**IMPORTANT:** a preliminary step to export the scripting reference is to build the necessary docker image. For that, issue: +> **NOTE**: At the time of writing, the documentation has to deployed manually to production. Please refer to the dedicated section below. -> `make gdm-build` +Exporting the Engine API refs is necessary to preview it locally. Also, the export procedure will be automatically triggered before every manual deploy to production. To extract the API refs without issuing a deploy, a make command has been made available. -and wait for the build to end successfully. Once it's done you can issue: +> `make docs-extract` -> `make gdm-generate` - -to export all of the engine API docs to markdown format. +All of the engine API docs will be exported to markdown format. The exported refereces will be available in `The Engine Handbook > Scripting Reference` section of the documentation. -**NOTE**: There is no live-reload of the source code. If you change the docblocks in the engine's source files, you will have to manually export local refs again. +**NOTE**: There is no live-reload from the plugin source code. If you change the docblocks in the engine's source files, you will have to manually export local refs again. -**NOTE**: Locally generated exports are ignored by Git. +**NOTE**: To avoid redundancy, exported API refs are ignored by Git, so only the documentation source files and the GDScript source files are versioned. ## How to publish the documentation to production -MkDocs is automatically triggered by GitHub automation so that new versions of the documentation are published whit every new release. +~~MkDocs is automatically triggered by GitHub Actions automation so that new versions of the documentation are published whit every new release.~~ + +At the time of writing, the documentation has to be deployed manually to Github Pages. A make command is available for this task, that takes care of everything, that can be issued from every working branch (but will be usually be run from `develop`). + +> `make docs-deploy` + +> **NOTE**: This command requires writing permissions on Popochiu main repository, so it can be issued only by core project contributors. + +This command will create a local `gh-pages` branch. This branch can be thrown away, but the best option is to keep a local copy of it, because this will speed up subsequent update deploys. -> TODO: create a live documentation site for dev branch too. +> **NOTE**: The `gh-pages` branch contents will differ entirely from the other branches of the project. You should **NEVER** commit manually on the `gh-pages` branch, nor trying to merge it back to a source branch. It would be bad. Like... try to imagine all life as you know it stopping instantaneously and every molecule in your body exploding at the speed of light. Allright, that's bad. ## Additional information 1. For those who make use of DNSDock or Dinghy Proxy, the documentation can be accessed visiting [http://docs.popochiu.local](docs.popochiu.local) on port `80`. -2. You can do without GNU Make and use Docker Compose direcly, issueing: +2. If you are really searching for trouble, and/or if you know what you're doing, you can do without GNU Make and use Docker Compose direcly, with: * `docker compose up -d` to run the service in background * `docker compose down` to stop the service * `docker compose up` to run the service and display logs in the console (`ctrl-c` will stop the service and send you back to the console) diff --git a/docs-src/content/the-engine-handbook/.gitkeep b/docs/dist/.gitkeep similarity index 100% rename from docs-src/content/the-engine-handbook/.gitkeep rename to docs/dist/.gitkeep diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml new file mode 100644 index 00000000..5a10cc1b --- /dev/null +++ b/docs/docker-compose.yml @@ -0,0 +1,23 @@ +version: "3" +services: + documentation: + ports: + - 286:80 + volumes: + - .:/app + working_dir: /app + labels: + - com.dnsdock.alias=docs.popochiu.local + build: + context: . + dockerfile: Dockerfile.MkDocs + command: serve -a 0.0.0.0:80 + docs-extractor: + volumes: + - ..:/project + - ./src/the-engine-handbook/scripting-reference:/output + profiles: + - tools + build: + context: . + dockerfile: Dockerfile.DocsExtractor diff --git a/mkdocs.yml b/docs/mkdocs.yml similarity index 75% rename from mkdocs.yml rename to docs/mkdocs.yml index 52e8b740..5a3a5b9e 100644 --- a/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,5 +1,12 @@ -site_name: Popochiu +site_name: Popochiu Documentation +site_description: Home to the documentation of Popochiu, a Godot plugin to build point-and-click adventure games. +site_author: The Carenalgas Community +copyright: Copyright (c) 2024 - The Carenalgas Community repo_url: https://github.com/carenalgas/popochiu/ +edit_uri: edit/develop/docs/src/ +docs_dir: src +site_dir: dist +theme: readthedocs extra_css: - assets/css/custom.css - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/tomorrow-night-bright.min.css @@ -18,6 +25,3 @@ markdown_extensions: plugins: - search - mkdocs-nav-weight -theme: readthedocs -docs_dir: docs-src/content -site_dir: docs diff --git a/docs/scripts/deploy_to_ghpages b/docs/scripts/deploy_to_ghpages new file mode 100755 index 00000000..4ee17b94 --- /dev/null +++ b/docs/scripts/deploy_to_ghpages @@ -0,0 +1,220 @@ +#!/usr/bin/env bash +set -o errexit #abort if any command fails +me=$(basename "$0") + +help_message="\ +Usage: $me [-c FILE] [] +Deploy generated files to a git branch. + +Options: + + -h, --help Show this help information. + -v, --verbose Increase verbosity. Useful for debugging. + -e, --allow-empty Allow deployment of an empty directory. + -m, --message MESSAGE Specify the message used when committing on the + deploy branch. + -n, --no-hash Don't append the source commit's hash to the deploy + commit's message. + -c, --config-file PATH Override default & environment variables' values + with those in set in the file at 'PATH'. Must be the + first option specified. + +Variables: + + GIT_DEPLOY_DIR Folder path containing the files to deploy. + GIT_DEPLOY_BRANCH Commit deployable files to this branch. + GIT_DEPLOY_REPO Push the deploy branch to this repository. + +These variables have default values defined in the script. The defaults can be +overridden by environment variables. Any environment variables are overridden +by values set in a '.env' file (if it exists), and in turn by those set in a +file specified by the '--config-file' option." + +parse_args() { + # Set args from a local environment file. + if [ -e ".env" ]; then + source .env + fi + + # Set args from file specified on the command-line. + if [[ $1 = "-c" || $1 = "--config-file" ]]; then + source "$2" + shift 2 + fi + + # Parse arg flags + # If something is exposed as an environment variable, set/overwrite it + # here. Otherwise, set/overwrite the internal variable instead. + while : ; do + if [[ $1 = "-h" || $1 = "--help" ]]; then + echo "$help_message" + return 0 + elif [[ $1 = "-v" || $1 = "--verbose" ]]; then + verbose=true + shift + elif [[ $1 = "-e" || $1 = "--allow-empty" ]]; then + allow_empty=true + shift + elif [[ ( $1 = "-m" || $1 = "--message" ) && -n $2 ]]; then + commit_message=$2 + shift 2 + elif [[ $1 = "-n" || $1 = "--no-hash" ]]; then + GIT_DEPLOY_APPEND_HASH=false + shift + else + break + fi + done + + # Set internal option vars from the environment and arg flags. All internal + # vars should be declared here, with sane defaults if applicable. + + # Source directory & target branch. + deploy_directory=${GIT_DEPLOY_DIR:-dist} + deploy_branch=${GIT_DEPLOY_BRANCH:-gh-pages} + + #if no user identity is already set in the current git environment, use this: + default_username=${GIT_DEPLOY_USERNAME:-Mapedorr} + default_email=${GIT_DEPLOY_EMAIL:-mapedorr@gmail.com} + + #repository to deploy to. must be readable and writable. + repo=${GIT_DEPLOY_REPO:-origin} + + #append commit hash to the end of message by default + append_hash=${GIT_DEPLOY_APPEND_HASH:-true} +} + +main() { + parse_args "$@" + + enable_expanded_output + + if ! git diff --exit-code --quiet --cached; then + echo Aborting due to uncommitted changes in the index >&2 + return 1 + fi + + commit_title=`git log -n 1 --format="%s" HEAD` + commit_hash=` git log -n 1 --format="%H" HEAD` + + #default commit message uses last title if a custom one is not supplied + if [[ -z $commit_message ]]; then + commit_message="publish: $commit_title" + fi + + #append hash to commit message unless no hash flag was found + if [ $append_hash = true ]; then + commit_message="$commit_message"$'\n\n'"generated from commit $commit_hash" + fi + + previous_branch=`git rev-parse --abbrev-ref HEAD` + + if [ ! -d "$deploy_directory" ]; then + echo "Deploy directory '$deploy_directory' does not exist. Aborting." >&2 + return 1 + fi + + # must use short form of flag in ls for compatibility with OS X and BSD + if [[ -z `ls -A "$deploy_directory" 2> /dev/null` && -z $allow_empty ]]; then + echo "Deploy directory '$deploy_directory' is empty. Aborting. If you're sure you want to deploy an empty tree, use the --allow-empty / -e flag." >&2 + return 1 + fi + + if git ls-remote --exit-code $repo "refs/heads/$deploy_branch" ; then + # deploy_branch exists in $repo; make sure we have the latest version + + disable_expanded_output + git fetch --force $repo $deploy_branch:$deploy_branch + enable_expanded_output + fi + + # check if deploy_branch exists locally + if git show-ref --verify --quiet "refs/heads/$deploy_branch" + then incremental_deploy + else initial_deploy + fi + + restore_head +} + +initial_deploy() { + git --work-tree "$deploy_directory" checkout --orphan $deploy_branch + git --work-tree "$deploy_directory" add --all + commit+push +} + +incremental_deploy() { + #make deploy_branch the current branch + git symbolic-ref HEAD refs/heads/$deploy_branch + #put the previously committed contents of deploy_branch into the index + git --work-tree "$deploy_directory" reset --mixed --quiet + git --work-tree "$deploy_directory" add --all + + set +o errexit + diff=$(git --work-tree "$deploy_directory" diff --exit-code --quiet HEAD --)$? + set -o errexit + case $diff in + 0) echo No changes to files in $deploy_directory. Skipping commit.;; + 1) commit+push;; + *) + echo git diff exited with code $diff. Aborting. Staying on branch $deploy_branch so you can debug. To switch back to master, use: git symbolic-ref HEAD refs/heads/master && git reset --mixed >&2 + return $diff + ;; + esac +} + +commit+push() { + set_user_id + git --work-tree "$deploy_directory" commit -m "$commit_message" + + disable_expanded_output + #--quiet is important here to avoid outputting the repo URL, which may contain a secret token + git push --quiet $repo $deploy_branch + enable_expanded_output +} + +#echo expanded commands as they are executed (for debugging) +enable_expanded_output() { + if [ $verbose ]; then + set -o xtrace + set +o verbose + fi +} + +#this is used to avoid outputting the repo URL, which may contain a secret token +disable_expanded_output() { + if [ $verbose ]; then + set +o xtrace + set -o verbose + fi +} + +set_user_id() { + if [[ -z `git config user.name` ]]; then + git config user.name "$default_username" + fi + if [[ -z `git config user.email` ]]; then + git config user.email "$default_email" + fi +} + +restore_head() { + if [[ $previous_branch = "HEAD" ]]; then + #we weren't on any branch before, so just set HEAD back to the commit it was on + git update-ref --no-deref HEAD $commit_hash $deploy_branch + else + git symbolic-ref HEAD refs/heads/$previous_branch + fi + + git reset --mixed +} + +filter() { + sed -e "s|$repo|\$repo|g" +} + +sanitize() { + "$@" 2> >(filter 1>&2) | filter +} + +[[ $1 = --source-only ]] || main "$@" diff --git a/generate_reference b/docs/scripts/generate_reference similarity index 100% rename from generate_reference rename to docs/scripts/generate_reference diff --git a/docs-src/content/advanced-techniques/advanced-animations.md b/docs/src/advanced-techniques/advanced-animations.md similarity index 100% rename from docs-src/content/advanced-techniques/advanced-animations.md rename to docs/src/advanced-techniques/advanced-animations.md diff --git a/docs-src/content/advanced-techniques/extending-customizing-popochiu.md b/docs/src/advanced-techniques/extending-customizing-popochiu.md similarity index 100% rename from docs-src/content/advanced-techniques/extending-customizing-popochiu.md rename to docs/src/advanced-techniques/extending-customizing-popochiu.md diff --git a/docs-src/content/advanced-techniques/game-state-saving-loading.md b/docs/src/advanced-techniques/game-state-saving-loading.md similarity index 100% rename from docs-src/content/advanced-techniques/game-state-saving-loading.md rename to docs/src/advanced-techniques/game-state-saving-loading.md diff --git a/docs-src/content/advanced-techniques/guis.md b/docs/src/advanced-techniques/guis.md similarity index 100% rename from docs-src/content/advanced-techniques/guis.md rename to docs/src/advanced-techniques/guis.md diff --git a/docs-src/content/advanced-techniques/index.md b/docs/src/advanced-techniques/index.md similarity index 100% rename from docs-src/content/advanced-techniques/index.md rename to docs/src/advanced-techniques/index.md diff --git a/docs-src/content/advanced-techniques/localization.md b/docs/src/advanced-techniques/localization.md similarity index 100% rename from docs-src/content/advanced-techniques/localization.md rename to docs/src/advanced-techniques/localization.md diff --git a/docs-src/content/assets/css/algolia.css b/docs/src/assets/css/algolia.css similarity index 100% rename from docs-src/content/assets/css/algolia.css rename to docs/src/assets/css/algolia.css diff --git a/docs-src/content/assets/css/custom.css b/docs/src/assets/css/custom.css similarity index 100% rename from docs-src/content/assets/css/custom.css rename to docs/src/assets/css/custom.css diff --git a/docs-src/content/assets/css/dev.css b/docs/src/assets/css/dev.css similarity index 100% rename from docs-src/content/assets/css/dev.css rename to docs/src/assets/css/dev.css diff --git a/docs-src/content/assets/css/fonts/JetBrainsMono-Bold.woff2 b/docs/src/assets/css/fonts/JetBrainsMono-Bold.woff2 similarity index 100% rename from docs-src/content/assets/css/fonts/JetBrainsMono-Bold.woff2 rename to docs/src/assets/css/fonts/JetBrainsMono-Bold.woff2 diff --git a/docs-src/content/assets/css/fonts/JetBrainsMono-Medium.woff2 b/docs/src/assets/css/fonts/JetBrainsMono-Medium.woff2 similarity index 100% rename from docs-src/content/assets/css/fonts/JetBrainsMono-Medium.woff2 rename to docs/src/assets/css/fonts/JetBrainsMono-Medium.woff2 diff --git a/docs-src/content/assets/css/fonts/JetBrainsMono-Regular.woff2 b/docs/src/assets/css/fonts/JetBrainsMono-Regular.woff2 similarity index 100% rename from docs-src/content/assets/css/fonts/JetBrainsMono-Regular.woff2 rename to docs/src/assets/css/fonts/JetBrainsMono-Regular.woff2 diff --git a/docs-src/content/assets/images/aseprite_importer-activate_importer-character.png b/docs/src/assets/images/aseprite_importer-activate_importer-character.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-activate_importer-character.png rename to docs/src/assets/images/aseprite_importer-activate_importer-character.png diff --git a/docs-src/content/assets/images/aseprite_importer-activate_importer-room.png b/docs/src/assets/images/aseprite_importer-activate_importer-room.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-activate_importer-room.png rename to docs/src/assets/images/aseprite_importer-activate_importer-room.png diff --git a/docs-src/content/assets/images/aseprite_importer-importer_interface-character.png b/docs/src/assets/images/aseprite_importer-importer_interface-character.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-importer_interface-character.png rename to docs/src/assets/images/aseprite_importer-importer_interface-character.png diff --git a/docs-src/content/assets/images/aseprite_importer-importer_interface-room-diff.png b/docs/src/assets/images/aseprite_importer-importer_interface-room-diff.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-importer_interface-room-diff.png rename to docs/src/assets/images/aseprite_importer-importer_interface-room-diff.png diff --git a/docs-src/content/assets/images/aseprite_importer-importer_interface-room.png b/docs/src/assets/images/aseprite_importer-importer_interface-room.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-importer_interface-room.png rename to docs/src/assets/images/aseprite_importer-importer_interface-room.png diff --git a/docs-src/content/assets/images/aseprite_importer-settings-es.png b/docs/src/assets/images/aseprite_importer-settings-es.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-settings-es.png rename to docs/src/assets/images/aseprite_importer-settings-es.png diff --git a/docs-src/content/assets/images/aseprite_importer-settings-ps.png b/docs/src/assets/images/aseprite_importer-settings-ps.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-settings-ps.png rename to docs/src/assets/images/aseprite_importer-settings-ps.png diff --git a/docs-src/content/assets/images/aseprite_importer-source_file_example-character.png b/docs/src/assets/images/aseprite_importer-source_file_example-character.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-source_file_example-character.png rename to docs/src/assets/images/aseprite_importer-source_file_example-character.png diff --git a/docs-src/content/assets/images/aseprite_importer-source_file_example-room-1.png b/docs/src/assets/images/aseprite_importer-source_file_example-room-1.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-source_file_example-room-1.png rename to docs/src/assets/images/aseprite_importer-source_file_example-room-1.png diff --git a/docs-src/content/assets/images/aseprite_importer-source_file_example-room-2.png b/docs/src/assets/images/aseprite_importer-source_file_example-room-2.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-source_file_example-room-2.png rename to docs/src/assets/images/aseprite_importer-source_file_example-room-2.png diff --git a/docs-src/content/assets/images/aseprite_importer-source_file_example-room-3.png b/docs/src/assets/images/aseprite_importer-source_file_example-room-3.png similarity index 100% rename from docs-src/content/assets/images/aseprite_importer-source_file_example-room-3.png rename to docs/src/assets/images/aseprite_importer-source_file_example-room-3.png diff --git a/docs-src/content/assets/images/audio_tab-context_not_assigned.png b/docs/src/assets/images/audio_tab-context_not_assigned.png similarity index 100% rename from docs-src/content/assets/images/audio_tab-context_not_assigned.png rename to docs/src/assets/images/audio_tab-context_not_assigned.png diff --git a/docs-src/content/assets/images/audio_tab-context_shared.png b/docs/src/assets/images/audio_tab-context_shared.png similarity index 100% rename from docs-src/content/assets/images/audio_tab-context_shared.png rename to docs/src/assets/images/audio_tab-context_shared.png diff --git a/docs-src/content/assets/images/audio_tab-resource.png b/docs/src/assets/images/audio_tab-resource.png similarity index 100% rename from docs-src/content/assets/images/audio_tab-resource.png rename to docs/src/assets/images/audio_tab-resource.png diff --git a/docs-src/content/assets/images/audio_tab-row_buttons.png b/docs/src/assets/images/audio_tab-row_buttons.png similarity index 100% rename from docs-src/content/assets/images/audio_tab-row_buttons.png rename to docs/src/assets/images/audio_tab-row_buttons.png diff --git a/docs-src/content/assets/images/audio_tab.png b/docs/src/assets/images/audio_tab.png similarity index 100% rename from docs-src/content/assets/images/audio_tab.png rename to docs/src/assets/images/audio_tab.png diff --git a/docs-src/content/assets/images/getting_started-itch_cover.png b/docs/src/assets/images/getting_started-itch_cover.png similarity index 100% rename from docs-src/content/assets/images/getting_started-itch_cover.png rename to docs/src/assets/images/getting_started-itch_cover.png diff --git a/docs-src/content/assets/images/getting_started-popochiu_dock.png b/docs/src/assets/images/getting_started-popochiu_dock.png similarity index 100% rename from docs-src/content/assets/images/getting_started-popochiu_dock.png rename to docs/src/assets/images/getting_started-popochiu_dock.png diff --git a/docs-src/content/assets/images/getting_started-settings_button.png b/docs/src/assets/images/getting_started-settings_button.png similarity index 100% rename from docs-src/content/assets/images/getting_started-settings_button.png rename to docs/src/assets/images/getting_started-settings_button.png diff --git a/docs-src/content/assets/images/home_cover.png b/docs/src/assets/images/home_cover.png similarity index 100% rename from docs-src/content/assets/images/home_cover.png rename to docs/src/assets/images/home_cover.png diff --git a/docs-src/content/assets/images/icon-400.png b/docs/src/assets/images/icon-400.png similarity index 100% rename from docs-src/content/assets/images/icon-400.png rename to docs/src/assets/images/icon-400.png diff --git a/docs-src/content/assets/images/icon.png b/docs/src/assets/images/icon.png similarity index 100% rename from docs-src/content/assets/images/icon.png rename to docs/src/assets/images/icon.png diff --git a/docs-src/content/assets/images/icon_add_to_core.png b/docs/src/assets/images/icon_add_to_core.png similarity index 100% rename from docs-src/content/assets/images/icon_add_to_core.png rename to docs/src/assets/images/icon_add_to_core.png diff --git a/docs-src/content/assets/images/icon_character-trimmed.png b/docs/src/assets/images/icon_character-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_character-trimmed.png rename to docs/src/assets/images/icon_character-trimmed.png diff --git a/docs-src/content/assets/images/icon_dialog-trimmed.png b/docs/src/assets/images/icon_dialog-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_dialog-trimmed.png rename to docs/src/assets/images/icon_dialog-trimmed.png diff --git a/docs-src/content/assets/images/icon_hotspot-trimmed.png b/docs/src/assets/images/icon_hotspot-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_hotspot-trimmed.png rename to docs/src/assets/images/icon_hotspot-trimmed.png diff --git a/docs-src/content/assets/images/icon_inventory_item-trimmed.png b/docs/src/assets/images/icon_inventory_item-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_inventory_item-trimmed.png rename to docs/src/assets/images/icon_inventory_item-trimmed.png diff --git a/docs-src/content/assets/images/icon_inventory_item_start.png b/docs/src/assets/images/icon_inventory_item_start.png similarity index 100% rename from docs-src/content/assets/images/icon_inventory_item_start.png rename to docs/src/assets/images/icon_inventory_item_start.png diff --git a/docs-src/content/assets/images/icon_no_bg-200.png b/docs/src/assets/images/icon_no_bg-200.png similarity index 100% rename from docs-src/content/assets/images/icon_no_bg-200.png rename to docs/src/assets/images/icon_no_bg-200.png diff --git a/docs-src/content/assets/images/icon_no_bg-300.png b/docs/src/assets/images/icon_no_bg-300.png similarity index 100% rename from docs-src/content/assets/images/icon_no_bg-300.png rename to docs/src/assets/images/icon_no_bg-300.png diff --git a/docs-src/content/assets/images/icon_no_bg-400.png b/docs/src/assets/images/icon_no_bg-400.png similarity index 100% rename from docs-src/content/assets/images/icon_no_bg-400.png rename to docs/src/assets/images/icon_no_bg-400.png diff --git a/docs-src/content/assets/images/icon_no_bg-700.png b/docs/src/assets/images/icon_no_bg-700.png similarity index 100% rename from docs-src/content/assets/images/icon_no_bg-700.png rename to docs/src/assets/images/icon_no_bg-700.png diff --git a/docs-src/content/assets/images/icon_no_bg.png b/docs/src/assets/images/icon_no_bg.png similarity index 100% rename from docs-src/content/assets/images/icon_no_bg.png rename to docs/src/assets/images/icon_no_bg.png diff --git a/docs-src/content/assets/images/icon_player_character.png b/docs/src/assets/images/icon_player_character.png similarity index 100% rename from docs-src/content/assets/images/icon_player_character.png rename to docs/src/assets/images/icon_player_character.png diff --git a/docs-src/content/assets/images/icon_point-trimmed.png b/docs/src/assets/images/icon_point-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_point-trimmed.png rename to docs/src/assets/images/icon_point-trimmed.png diff --git a/docs-src/content/assets/images/icon_prop-trimmed.png b/docs/src/assets/images/icon_prop-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_prop-trimmed.png rename to docs/src/assets/images/icon_prop-trimmed.png diff --git a/docs-src/content/assets/images/icon_region-trimmed.png b/docs/src/assets/images/icon_region-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_region-trimmed.png rename to docs/src/assets/images/icon_region-trimmed.png diff --git a/docs-src/content/assets/images/icon_room-trimmed.png b/docs/src/assets/images/icon_room-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_room-trimmed.png rename to docs/src/assets/images/icon_room-trimmed.png diff --git a/docs-src/content/assets/images/icon_walkable_area-trimmed.png b/docs/src/assets/images/icon_walkable_area-trimmed.png similarity index 100% rename from docs-src/content/assets/images/icon_walkable_area-trimmed.png rename to docs/src/assets/images/icon_walkable_area-trimmed.png diff --git a/docs-src/content/assets/images/main_tab-context_character.png b/docs/src/assets/images/main_tab-context_character.png similarity index 100% rename from docs-src/content/assets/images/main_tab-context_character.png rename to docs/src/assets/images/main_tab-context_character.png diff --git a/docs-src/content/assets/images/main_tab-context_item.png b/docs/src/assets/images/main_tab-context_item.png similarity index 100% rename from docs-src/content/assets/images/main_tab-context_item.png rename to docs/src/assets/images/main_tab-context_item.png diff --git a/docs-src/content/assets/images/main_tab-context_room.png b/docs/src/assets/images/main_tab-context_room.png similarity index 100% rename from docs-src/content/assets/images/main_tab-context_room.png rename to docs/src/assets/images/main_tab-context_room.png diff --git a/docs-src/content/assets/images/main_tab-context_shared.png b/docs/src/assets/images/main_tab-context_shared.png similarity index 100% rename from docs-src/content/assets/images/main_tab-context_shared.png rename to docs/src/assets/images/main_tab-context_shared.png diff --git a/docs-src/content/assets/images/main_tab-row_buttons.png b/docs/src/assets/images/main_tab-row_buttons.png similarity index 100% rename from docs-src/content/assets/images/main_tab-row_buttons.png rename to docs/src/assets/images/main_tab-row_buttons.png diff --git a/docs-src/content/assets/images/main_tab.png b/docs/src/assets/images/main_tab.png similarity index 100% rename from docs-src/content/assets/images/main_tab.png rename to docs/src/assets/images/main_tab.png diff --git a/docs-src/content/assets/images/popochiu-v1.10_button-en.png b/docs/src/assets/images/popochiu-v1.10_button-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.10_button-en.png rename to docs/src/assets/images/popochiu-v1.10_button-en.png diff --git a/docs-src/content/assets/images/popochiu-v1.10_button-es.png b/docs/src/assets/images/popochiu-v1.10_button-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.10_button-es.png rename to docs/src/assets/images/popochiu-v1.10_button-es.png diff --git a/docs-src/content/assets/images/popochiu-v1.9_button-en.png b/docs/src/assets/images/popochiu-v1.9_button-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.9_button-en.png rename to docs/src/assets/images/popochiu-v1.9_button-en.png diff --git a/docs-src/content/assets/images/popochiu-v1.9_button-es.png b/docs/src/assets/images/popochiu-v1.9_button-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.9_button-es.png rename to docs/src/assets/images/popochiu-v1.9_button-es.png diff --git a/docs-src/content/assets/images/popochiu-v1.9_thumbnail-en.png b/docs/src/assets/images/popochiu-v1.9_thumbnail-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.9_thumbnail-en.png rename to docs/src/assets/images/popochiu-v1.9_thumbnail-en.png diff --git a/docs-src/content/assets/images/popochiu-v1.9_thumbnail-es.png b/docs/src/assets/images/popochiu-v1.9_thumbnail-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu-v1.9_thumbnail-es.png rename to docs/src/assets/images/popochiu-v1.9_thumbnail-es.png diff --git a/docs-src/content/assets/images/popochiu_2_hero-en.png b/docs/src/assets/images/popochiu_2_hero-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu_2_hero-en.png rename to docs/src/assets/images/popochiu_2_hero-en.png diff --git a/docs-src/content/assets/images/popochiu_2_hero-es.png b/docs/src/assets/images/popochiu_2_hero-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu_2_hero-es.png rename to docs/src/assets/images/popochiu_2_hero-es.png diff --git a/docs-src/content/assets/images/popochiu_hero-en.png b/docs/src/assets/images/popochiu_hero-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu_hero-en.png rename to docs/src/assets/images/popochiu_hero-en.png diff --git a/docs-src/content/assets/images/popochiu_hero-es.png b/docs/src/assets/images/popochiu_hero-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu_hero-es.png rename to docs/src/assets/images/popochiu_hero-es.png diff --git a/docs-src/content/assets/images/popochiu_list_of_features-en.png b/docs/src/assets/images/popochiu_list_of_features-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu_list_of_features-en.png rename to docs/src/assets/images/popochiu_list_of_features-en.png diff --git a/docs-src/content/assets/images/popochiu_list_of_features-es.png b/docs/src/assets/images/popochiu_list_of_features-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu_list_of_features-es.png rename to docs/src/assets/images/popochiu_list_of_features-es.png diff --git a/docs-src/content/assets/images/popochiu_tutorials_button-en.png b/docs/src/assets/images/popochiu_tutorials_button-en.png similarity index 100% rename from docs-src/content/assets/images/popochiu_tutorials_button-en.png rename to docs/src/assets/images/popochiu_tutorials_button-en.png diff --git a/docs-src/content/assets/images/popochiu_tutorials_button-es.png b/docs/src/assets/images/popochiu_tutorials_button-es.png similarity index 100% rename from docs-src/content/assets/images/popochiu_tutorials_button-es.png rename to docs/src/assets/images/popochiu_tutorials_button-es.png diff --git a/docs-src/content/assets/images/room_tab-context_shared.png b/docs/src/assets/images/room_tab-context_shared.png similarity index 100% rename from docs-src/content/assets/images/room_tab-context_shared.png rename to docs/src/assets/images/room_tab-context_shared.png diff --git a/docs-src/content/assets/images/room_tab-header.png b/docs/src/assets/images/room_tab-header.png similarity index 100% rename from docs-src/content/assets/images/room_tab-header.png rename to docs/src/assets/images/room_tab-header.png diff --git a/docs-src/content/assets/images/room_tab-row_buttons.png b/docs/src/assets/images/room_tab-row_buttons.png similarity index 100% rename from docs-src/content/assets/images/room_tab-row_buttons.png rename to docs/src/assets/images/room_tab-row_buttons.png diff --git a/docs-src/content/assets/images/room_tab.png b/docs/src/assets/images/room_tab.png similarity index 100% rename from docs-src/content/assets/images/room_tab.png rename to docs/src/assets/images/room_tab.png diff --git a/docs-src/content/assets/images/settings-text_continue_mode.png b/docs/src/assets/images/settings-text_continue_mode.png similarity index 100% rename from docs-src/content/assets/images/settings-text_continue_mode.png rename to docs/src/assets/images/settings-text_continue_mode.png diff --git a/docs-src/content/assets/images/settings-text_speeds.png b/docs/src/assets/images/settings-text_speeds.png similarity index 100% rename from docs-src/content/assets/images/settings-text_speeds.png rename to docs/src/assets/images/settings-text_speeds.png diff --git a/docs-src/content/assets/images/settings.png b/docs/src/assets/images/settings.png similarity index 100% rename from docs-src/content/assets/images/settings.png rename to docs/src/assets/images/settings.png diff --git a/docs-src/content/assets/images/thumbnail-01-create_room_and_character.jpg b/docs/src/assets/images/thumbnail-01-create_room_and_character.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-01-create_room_and_character.jpg rename to docs/src/assets/images/thumbnail-01-create_room_and_character.jpg diff --git a/docs-src/content/assets/images/thumbnail-02-baseline_gap_hotspot.jpg b/docs/src/assets/images/thumbnail-02-baseline_gap_hotspot.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-02-baseline_gap_hotspot.jpg rename to docs/src/assets/images/thumbnail-02-baseline_gap_hotspot.jpg diff --git a/docs-src/content/assets/images/thumbnail-03-prop_inventory_item.jpg b/docs/src/assets/images/thumbnail-03-prop_inventory_item.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-03-prop_inventory_item.jpg rename to docs/src/assets/images/thumbnail-03-prop_inventory_item.jpg diff --git a/docs-src/content/assets/images/thumbnail-04-character_dialog.jpg b/docs/src/assets/images/thumbnail-04-character_dialog.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-04-character_dialog.jpg rename to docs/src/assets/images/thumbnail-04-character_dialog.jpg diff --git a/docs-src/content/assets/images/thumbnail-05-dialog_options_use_item.jpg b/docs/src/assets/images/thumbnail-05-dialog_options_use_item.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-05-dialog_options_use_item.jpg rename to docs/src/assets/images/thumbnail-05-dialog_options_use_item.jpg diff --git a/docs-src/content/assets/images/thumbnail-06-room_change.jpg b/docs/src/assets/images/thumbnail-06-room_change.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-06-room_change.jpg rename to docs/src/assets/images/thumbnail-06-room_change.jpg diff --git a/docs-src/content/assets/images/thumbnail-07-add_audio.jpg b/docs/src/assets/images/thumbnail-07-add_audio.jpg similarity index 100% rename from docs-src/content/assets/images/thumbnail-07-add_audio.jpg rename to docs/src/assets/images/thumbnail-07-add_audio.jpg diff --git a/docs-src/content/assets/js/custom.js b/docs/src/assets/js/custom.js similarity index 100% rename from docs-src/content/assets/js/custom.js rename to docs/src/assets/js/custom.js diff --git a/docs-src/content/assets/js/gdscript.min.js b/docs/src/assets/js/gdscript.min.js similarity index 100% rename from docs-src/content/assets/js/gdscript.min.js rename to docs/src/assets/js/gdscript.min.js diff --git a/docs-src/content/contributing-to-popochiu/coding-standards.md b/docs/src/contributing-to-popochiu/coding-standards.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/coding-standards.md rename to docs/src/contributing-to-popochiu/coding-standards.md diff --git a/docs-src/content/contributing-to-popochiu/getting-help.md b/docs/src/contributing-to-popochiu/getting-help.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/getting-help.md rename to docs/src/contributing-to-popochiu/getting-help.md diff --git a/docs-src/content/contributing-to-popochiu/index.md b/docs/src/contributing-to-popochiu/index.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/index.md rename to docs/src/contributing-to-popochiu/index.md diff --git a/docs-src/content/contributing-to-popochiu/project-management.md b/docs/src/contributing-to-popochiu/project-management.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/project-management.md rename to docs/src/contributing-to-popochiu/project-management.md diff --git a/docs-src/content/contributing-to-popochiu/project-overview.md b/docs/src/contributing-to-popochiu/project-overview.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/project-overview.md rename to docs/src/contributing-to-popochiu/project-overview.md diff --git a/docs-src/content/contributing-to-popochiu/toolchain-and-dependencies.md b/docs/src/contributing-to-popochiu/toolchain-and-dependencies.md similarity index 100% rename from docs-src/content/contributing-to-popochiu/toolchain-and-dependencies.md rename to docs/src/contributing-to-popochiu/toolchain-and-dependencies.md diff --git a/docs-src/content/getting-started/creating-a-game-stub.md b/docs/src/getting-started/creating-a-game-stub.md similarity index 94% rename from docs-src/content/getting-started/creating-a-game-stub.md rename to docs/src/getting-started/creating-a-game-stub.md index b1c1e741..95ed4bb2 100644 --- a/docs-src/content/getting-started/creating-a-game-stub.md +++ b/docs/src/getting-started/creating-a-game-stub.md @@ -2,7 +2,7 @@ weight: 1020 --- -This page will guide you trought the process of creating a very small stub for a game. +This page will guide you through the process of creating a very small stub for a game. The purpose of this page is to quickly get you set up to experiment and tinker as you read this documentation. If you are already familiar with Popochiu or have already created your project, you can skip to the [Tutorials](/getting-started/tutorials) section. diff --git a/docs-src/content/getting-started/example-resources.md b/docs/src/getting-started/example-resources.md similarity index 100% rename from docs-src/content/getting-started/example-resources.md rename to docs/src/getting-started/example-resources.md diff --git a/docs-src/content/getting-started/getting-help.md b/docs/src/getting-started/getting-help.md similarity index 100% rename from docs-src/content/getting-started/getting-help.md rename to docs/src/getting-started/getting-help.md diff --git a/docs-src/content/getting-started/index.md b/docs/src/getting-started/index.md similarity index 100% rename from docs-src/content/getting-started/index.md rename to docs/src/getting-started/index.md diff --git a/docs-src/content/getting-started/installing-popochiu.md b/docs/src/getting-started/installing-popochiu.md similarity index 100% rename from docs-src/content/getting-started/installing-popochiu.md rename to docs/src/getting-started/installing-popochiu.md diff --git a/docs-src/content/getting-started/tutorials.md b/docs/src/getting-started/tutorials.md similarity index 100% rename from docs-src/content/getting-started/tutorials.md rename to docs/src/getting-started/tutorials.md diff --git a/docs-src/content/how-to-develop-a-game/adding-sound.md b/docs/src/how-to-develop-a-game/adding-sound.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/adding-sound.md rename to docs/src/how-to-develop-a-game/adding-sound.md diff --git a/docs-src/content/how-to-develop-a-game/creating-characters.md b/docs/src/how-to-develop-a-game/creating-characters.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/creating-characters.md rename to docs/src/how-to-develop-a-game/creating-characters.md diff --git a/docs-src/content/how-to-develop-a-game/creating-rooms.md b/docs/src/how-to-develop-a-game/creating-rooms.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/creating-rooms.md rename to docs/src/how-to-develop-a-game/creating-rooms.md diff --git a/docs-src/content/how-to-develop-a-game/index.md b/docs/src/how-to-develop-a-game/index.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/index.md rename to docs/src/how-to-develop-a-game/index.md diff --git a/docs-src/content/how-to-develop-a-game/kickstarting-a-project.md b/docs/src/how-to-develop-a-game/kickstarting-a-project.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/kickstarting-a-project.md rename to docs/src/how-to-develop-a-game/kickstarting-a-project.md diff --git a/docs-src/content/how-to-develop-a-game/managing-the-inventory.md b/docs/src/how-to-develop-a-game/managing-the-inventory.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/managing-the-inventory.md rename to docs/src/how-to-develop-a-game/managing-the-inventory.md diff --git a/docs-src/content/how-to-develop-a-game/playing-animations.md b/docs/src/how-to-develop-a-game/playing-animations.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/playing-animations.md rename to docs/src/how-to-develop-a-game/playing-animations.md diff --git a/docs-src/content/how-to-develop-a-game/scripting-interactions.md b/docs/src/how-to-develop-a-game/scripting-interactions.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/scripting-interactions.md rename to docs/src/how-to-develop-a-game/scripting-interactions.md diff --git a/docs-src/content/how-to-develop-a-game/writing-dialogues.md b/docs/src/how-to-develop-a-game/writing-dialogues.md similarity index 100% rename from docs-src/content/how-to-develop-a-game/writing-dialogues.md rename to docs/src/how-to-develop-a-game/writing-dialogues.md diff --git a/docs-src/content/index.md b/docs/src/index.md similarity index 100% rename from docs-src/content/index.md rename to docs/src/index.md diff --git a/docs-src/content/the-editor-handbook/editor-settings.md b/docs/src/the-editor-handbook/editor-settings.md similarity index 100% rename from docs-src/content/the-editor-handbook/editor-settings.md rename to docs/src/the-editor-handbook/editor-settings.md diff --git a/docs-src/content/the-editor-handbook/importers.md b/docs/src/the-editor-handbook/importers.md similarity index 100% rename from docs-src/content/the-editor-handbook/importers.md rename to docs/src/the-editor-handbook/importers.md diff --git a/docs-src/content/the-editor-handbook/index.md b/docs/src/the-editor-handbook/index.md similarity index 100% rename from docs-src/content/the-editor-handbook/index.md rename to docs/src/the-editor-handbook/index.md diff --git a/docs-src/content/the-editor-handbook/interface-overview.md b/docs/src/the-editor-handbook/interface-overview.md similarity index 100% rename from docs-src/content/the-editor-handbook/interface-overview.md rename to docs/src/the-editor-handbook/interface-overview.md diff --git a/docs-src/content/the-editor-handbook/popochiu-dock.md b/docs/src/the-editor-handbook/popochiu-dock.md similarity index 100% rename from docs-src/content/the-editor-handbook/popochiu-dock.md rename to docs/src/the-editor-handbook/popochiu-dock.md diff --git a/docs-src/content/the-editor-handbook/toolbar-buttons.md b/docs/src/the-editor-handbook/toolbar-buttons.md similarity index 100% rename from docs-src/content/the-editor-handbook/toolbar-buttons.md rename to docs/src/the-editor-handbook/toolbar-buttons.md diff --git a/docs-src/content/the-engine-handbook/scripting-reference/.gitkeep b/docs/src/the-engine-handbook/.gitkeep similarity index 100% rename from docs-src/content/the-engine-handbook/scripting-reference/.gitkeep rename to docs/src/the-engine-handbook/.gitkeep diff --git a/docs-src/content/the-engine-handbook/index.md b/docs/src/the-engine-handbook/index.md similarity index 100% rename from docs-src/content/the-engine-handbook/index.md rename to docs/src/the-engine-handbook/index.md diff --git a/docs-src/content/the-engine-handbook/scripting-overview.md b/docs/src/the-engine-handbook/scripting-overview.md similarity index 100% rename from docs-src/content/the-engine-handbook/scripting-overview.md rename to docs/src/the-engine-handbook/scripting-overview.md diff --git a/docs/.gitkeep b/docs/src/the-engine-handbook/scripting-reference/.gitkeep similarity index 100% rename from docs/.gitkeep rename to docs/src/the-engine-handbook/scripting-reference/.gitkeep