diff --git a/.github/workflows/documentation-build.yml b/.github/workflows/documentation-build.yml
index f13b964cd..91ee14e3e 100644
--- a/.github/workflows/documentation-build.yml
+++ b/.github/workflows/documentation-build.yml
@@ -28,12 +28,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- - name: "Checkout code"
+ - name: "Checkout"
uses: actions/checkout@v7
with:
submodules: recursive
- name: "Install Graphviz"
+ shell: bash
run: |
sudo apt-get install -y graphviz
dot -V
@@ -44,6 +45,7 @@ jobs:
version: "1.18.0"
- name: "Update Doxygen Configuration"
+ shell: bash
run: |
git diff Doxyfile
doxygen -u Doxyfile
@@ -58,9 +60,10 @@ jobs:
- name: "Generate Documentation"
if: always()
+ shell: bash
run: doxygen Doxyfile
- - name: "Deploy to cockatrice.github.io"
+ - name: "Deploy to cockatrice.github.io/docs"
if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'
uses: peaceiris/actions-gh-pages@v4
with:
@@ -69,3 +72,8 @@ jobs:
external_repository: Cockatrice/cockatrice.github.io
publish_branch: master
publish_dir: ./docs/html
+
+ - name: Link to Documentation Page
+ if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'
+ shell: bash
+ run: echo "::notice title=New documentation published::Shortly available at https://cockatrice.github.io/docs/"
diff --git a/Doxyfile b/Doxyfile
index b722f779f..c12ff4a8a 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1066,25 +1066,11 @@ INPUT_FILE_ENCODING =
# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
-FILE_PATTERNS = *.cc \
- *.cxx \
- *.cxxm \
- *.cpp \
+FILE_PATTERNS = *.cpp \
*.cppm \
- *.ccm \
- *.c++ \
- *.c++m \
- *.ii \
- *.ixx \
*.ipp \
- *.i++ \
*.inl \
*.h \
- *.hh \
- *.hxx \
- *.hpp \
- *.h++ \
- *.markdown \
*.md \
*.dox \
*.proto
diff --git a/doc/doxygen/README.md b/doc/doxygen/README.md
index 0e6cee7f4..230422303 100644
--- a/doc/doxygen/README.md
+++ b/doc/doxygen/README.md
@@ -1,13 +1,16 @@
## Building Doxygen Documentation
We use [Doxygen](https://www.doxygen.nl) for our code documentation.
-After installing the tool, you can build a HTML webpage into `/docs` folder according to our [configuration](https://github.com/Cockatrice/Cockatrice/blob/master/Doxyfile):
+After installing the tool, you can build a HTML webpage into the `/docs` folder according to our [configuration](https://github.com/Cockatrice/Cockatrice/blob/master/Doxyfile):
```bash
doxygen Doxyfile
```
-Open the `index.html` file in the `/docs/html/` folder to view and use it.
+Open the `index.html` file in the `/docs/html/` folder to browse the result locally.
There is also an online version we host at the Cockatrice webpage: [cockatrice.github.io/docs](https://cockatrice.github.io/docs)
+Doxygen's own documenation can be found at [www.doxygen.nl/manual](https://www.doxygen.nl/manual).
+
+
## Doxygen Documentation Theme
diff --git a/doc/doxygen/images/cockatrice_logo.svg b/doc/doxygen/images/cockatrice_logo.svg
new file mode 100644
index 000000000..89ba62dcf
--- /dev/null
+++ b/doc/doxygen/images/cockatrice_logo.svg
@@ -0,0 +1,232 @@
+
+
+
+
diff --git a/doc/doxygen/images/classic_database_display.png b/doc/doxygen/images/screenshots/classic_database_display.png
similarity index 100%
rename from doc/doxygen/images/classic_database_display.png
rename to doc/doxygen/images/screenshots/classic_database_display.png
diff --git a/doc/doxygen/images/classic_database_display_add_buttons.png b/doc/doxygen/images/screenshots/classic_database_display_add_buttons.png
similarity index 100%
rename from doc/doxygen/images/classic_database_display_add_buttons.png
rename to doc/doxygen/images/screenshots/classic_database_display_add_buttons.png
diff --git a/doc/doxygen/images/classic_deck_editor.png b/doc/doxygen/images/screenshots/classic_deck_editor.png
similarity index 100%
rename from doc/doxygen/images/classic_deck_editor.png
rename to doc/doxygen/images/screenshots/classic_deck_editor.png
diff --git a/doc/doxygen/images/deck_dock_deck_list.png b/doc/doxygen/images/screenshots/deck_dock_deck_list.png
similarity index 100%
rename from doc/doxygen/images/deck_dock_deck_list.png
rename to doc/doxygen/images/screenshots/deck_dock_deck_list.png
diff --git a/doc/doxygen/images/deck_dock_deck_list_buttons.png b/doc/doxygen/images/screenshots/deck_dock_deck_list_buttons.png
similarity index 100%
rename from doc/doxygen/images/deck_dock_deck_list_buttons.png
rename to doc/doxygen/images/screenshots/deck_dock_deck_list_buttons.png
diff --git a/doc/doxygen/images/deck_dock_deck_list_group_by.png b/doc/doxygen/images/screenshots/deck_dock_deck_list_group_by.png
similarity index 100%
rename from doc/doxygen/images/deck_dock_deck_list_group_by.png
rename to doc/doxygen/images/screenshots/deck_dock_deck_list_group_by.png
diff --git a/doc/doxygen/images/deckeditordeckdockwidget.png b/doc/doxygen/images/screenshots/deckeditordeckdockwidget.png
similarity index 100%
rename from doc/doxygen/images/deckeditordeckdockwidget.png
rename to doc/doxygen/images/screenshots/deckeditordeckdockwidget.png
diff --git a/doc/doxygen/images/printing_selector.png b/doc/doxygen/images/screenshots/printing_selector.png
similarity index 100%
rename from doc/doxygen/images/printing_selector.png
rename to doc/doxygen/images/screenshots/printing_selector.png
diff --git a/doc/doxygen/images/printing_selector_disable.png b/doc/doxygen/images/screenshots/printing_selector_disable.png
similarity index 100%
rename from doc/doxygen/images/printing_selector_disable.png
rename to doc/doxygen/images/screenshots/printing_selector_disable.png
diff --git a/doc/doxygen/images/printing_selector_enable.png b/doc/doxygen/images/screenshots/printing_selector_enable.png
similarity index 100%
rename from doc/doxygen/images/printing_selector_enable.png
rename to doc/doxygen/images/screenshots/printing_selector_enable.png
diff --git a/doc/doxygen/images/printing_selector_navigation.png b/doc/doxygen/images/screenshots/printing_selector_navigation.png
similarity index 100%
rename from doc/doxygen/images/printing_selector_navigation.png
rename to doc/doxygen/images/screenshots/printing_selector_navigation.png
diff --git a/doc/doxygen/images/printing_selector_options.png b/doc/doxygen/images/screenshots/printing_selector_options.png
similarity index 100%
rename from doc/doxygen/images/printing_selector_options.png
rename to doc/doxygen/images/screenshots/printing_selector_options.png
diff --git a/doc/doxygen/images/printing_selector_pre_providerid.png b/doc/doxygen/images/screenshots/printing_selector_pre_providerid.png
similarity index 100%
rename from doc/doxygen/images/printing_selector_pre_providerid.png
rename to doc/doxygen/images/screenshots/printing_selector_pre_providerid.png
diff --git a/doc/doxygen/images/release_channel_beta.png b/doc/doxygen/images/screenshots/release_channel_beta.png
similarity index 100%
rename from doc/doxygen/images/release_channel_beta.png
rename to doc/doxygen/images/screenshots/release_channel_beta.png
diff --git a/doc/doxygen/images/vde_deck_analytics.png b/doc/doxygen/images/screenshots/vde_deck_analytics.png
similarity index 100%
rename from doc/doxygen/images/vde_deck_analytics.png
rename to doc/doxygen/images/screenshots/vde_deck_analytics.png
diff --git a/doc/doxygen/images/vde_flat_layout_color_grouped.png b/doc/doxygen/images/screenshots/vde_flat_layout_color_grouped.png
similarity index 100%
rename from doc/doxygen/images/vde_flat_layout_color_grouped.png
rename to doc/doxygen/images/screenshots/vde_flat_layout_color_grouped.png
diff --git a/doc/doxygen/images/vde_flat_layout_type_grouped.png b/doc/doxygen/images/screenshots/vde_flat_layout_type_grouped.png
similarity index 100%
rename from doc/doxygen/images/vde_flat_layout_type_grouped.png
rename to doc/doxygen/images/screenshots/vde_flat_layout_type_grouped.png
diff --git a/doc/doxygen/images/vde_overlap_layout_type_grouped.png b/doc/doxygen/images/screenshots/vde_overlap_layout_type_grouped.png
similarity index 100%
rename from doc/doxygen/images/vde_overlap_layout_type_grouped.png
rename to doc/doxygen/images/screenshots/vde_overlap_layout_type_grouped.png
diff --git a/doc/doxygen/images/vde_sample_hand.png b/doc/doxygen/images/screenshots/vde_sample_hand.png
similarity index 100%
rename from doc/doxygen/images/vde_sample_hand.png
rename to doc/doxygen/images/screenshots/vde_sample_hand.png
diff --git a/doc/doxygen/extra-pages/developer_documentation/card_database_schema_and_parsing.md b/doc/doxygen/pages/developer_documentation/card_database_schema_and_parsing.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/card_database_schema_and_parsing.md
rename to doc/doxygen/pages/developer_documentation/card_database_schema_and_parsing.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/displaying_cards.md b/doc/doxygen/pages/developer_documentation/displaying_cards.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/displaying_cards.md
rename to doc/doxygen/pages/developer_documentation/displaying_cards.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/index.md b/doc/doxygen/pages/developer_documentation/index.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/index.md
rename to doc/doxygen/pages/developer_documentation/index.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/loading_card_pictures.md b/doc/doxygen/pages/developer_documentation/loading_card_pictures.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/loading_card_pictures.md
rename to doc/doxygen/pages/developer_documentation/loading_card_pictures.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/logging.md b/doc/doxygen/pages/developer_documentation/logging.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/logging.md
rename to doc/doxygen/pages/developer_documentation/logging.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/client/game_event_handler.md b/doc/doxygen/pages/developer_documentation/network/client/game_event_handler.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/client/game_event_handler.md
rename to doc/doxygen/pages/developer_documentation/network/client/game_event_handler.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/client/index.md b/doc/doxygen/pages/developer_documentation/network/client/index.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/client/index.md
rename to doc/doxygen/pages/developer_documentation/network/client/index.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/client/player_event_handler.md b/doc/doxygen/pages/developer_documentation/network/client/player_event_handler.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/client/player_event_handler.md
rename to doc/doxygen/pages/developer_documentation/network/client/player_event_handler.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/index.md b/doc/doxygen/pages/developer_documentation/network/index.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/index.md
rename to doc/doxygen/pages/developer_documentation/network/index.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/index.md b/doc/doxygen/pages/developer_documentation/network/protocol/index.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/index.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/index.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_command_container.md b/doc/doxygen/pages/developer_documentation/network/protocol/protocol_command_container.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_command_container.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/protocol_command_container.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_game_command.md b/doc/doxygen/pages/developer_documentation/network/protocol/protocol_game_command.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_game_command.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/protocol_game_command.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_overview.md b/doc/doxygen/pages/developer_documentation/network/protocol/protocol_overview.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_overview.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/protocol_overview.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_response.md b/doc/doxygen/pages/developer_documentation/network/protocol/protocol_response.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_response.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/protocol_response.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_server_message.md b/doc/doxygen/pages/developer_documentation/network/protocol/protocol_server_message.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/network/protocol/protocol_server_message.md
rename to doc/doxygen/pages/developer_documentation/network/protocol/protocol_server_message.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/primer_cards.md b/doc/doxygen/pages/developer_documentation/primer_cards.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/primer_cards.md
rename to doc/doxygen/pages/developer_documentation/primer_cards.md
diff --git a/doc/doxygen/extra-pages/developer_documentation/querying_the_card_database.md b/doc/doxygen/pages/developer_documentation/querying_the_card_database.md
similarity index 100%
rename from doc/doxygen/extra-pages/developer_documentation/querying_the_card_database.md
rename to doc/doxygen/pages/developer_documentation/querying_the_card_database.md
diff --git a/doc/doxygen/extra-pages/index.md b/doc/doxygen/pages/index.md
similarity index 77%
rename from doc/doxygen/extra-pages/index.md
rename to doc/doxygen/pages/index.md
index b3363d3f4..9dafe1882 100644
--- a/doc/doxygen/extra-pages/index.md
+++ b/doc/doxygen/pages/index.md
@@ -1,5 +1,9 @@
@mainpage Documentation
+