[Docs] Add app logo to main page + cleanup (#7471)
Some checks failed
CodeQL / Analyze (cpp) (push) Has been cancelled
CodeQL / Analyze (actions) (push) Has been cancelled
Build Docker / Servatrice (arm) (push) Has been cancelled
Build Docker / Servatrice (x86) (push) Has been cancelled
Build Docker / Publish multi-platform Servatrice image (push) Has been cancelled
* Add app logo to main page * rename pages folder * Add link + cleanup * Cleanup file extension patterns * Update Doxygen README.md
12
.github/workflows/documentation-build.yml
vendored
|
|
@ -28,12 +28,13 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: "Checkout code"
|
- name: "Checkout"
|
||||||
uses: actions/checkout@v7
|
uses: actions/checkout@v7
|
||||||
with:
|
with:
|
||||||
submodules: recursive
|
submodules: recursive
|
||||||
|
|
||||||
- name: "Install Graphviz"
|
- name: "Install Graphviz"
|
||||||
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
sudo apt-get install -y graphviz
|
sudo apt-get install -y graphviz
|
||||||
dot -V
|
dot -V
|
||||||
|
|
@ -44,6 +45,7 @@ jobs:
|
||||||
version: "1.18.0"
|
version: "1.18.0"
|
||||||
|
|
||||||
- name: "Update Doxygen Configuration"
|
- name: "Update Doxygen Configuration"
|
||||||
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
git diff Doxyfile
|
git diff Doxyfile
|
||||||
doxygen -u Doxyfile
|
doxygen -u Doxyfile
|
||||||
|
|
@ -58,9 +60,10 @@ jobs:
|
||||||
|
|
||||||
- name: "Generate Documentation"
|
- name: "Generate Documentation"
|
||||||
if: always()
|
if: always()
|
||||||
|
shell: bash
|
||||||
run: doxygen Doxyfile
|
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'
|
if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'
|
||||||
uses: peaceiris/actions-gh-pages@v4
|
uses: peaceiris/actions-gh-pages@v4
|
||||||
with:
|
with:
|
||||||
|
|
@ -69,3 +72,8 @@ jobs:
|
||||||
external_repository: Cockatrice/cockatrice.github.io
|
external_repository: Cockatrice/cockatrice.github.io
|
||||||
publish_branch: master
|
publish_branch: master
|
||||||
publish_dir: ./docs/html
|
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/"
|
||||||
|
|
|
||||||
16
Doxyfile
|
|
@ -1066,25 +1066,11 @@ INPUT_FILE_ENCODING =
|
||||||
# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
|
# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
|
||||||
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
|
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
|
||||||
|
|
||||||
FILE_PATTERNS = *.cc \
|
FILE_PATTERNS = *.cpp \
|
||||||
*.cxx \
|
|
||||||
*.cxxm \
|
|
||||||
*.cpp \
|
|
||||||
*.cppm \
|
*.cppm \
|
||||||
*.ccm \
|
|
||||||
*.c++ \
|
|
||||||
*.c++m \
|
|
||||||
*.ii \
|
|
||||||
*.ixx \
|
|
||||||
*.ipp \
|
*.ipp \
|
||||||
*.i++ \
|
|
||||||
*.inl \
|
*.inl \
|
||||||
*.h \
|
*.h \
|
||||||
*.hh \
|
|
||||||
*.hxx \
|
|
||||||
*.hpp \
|
|
||||||
*.h++ \
|
|
||||||
*.markdown \
|
|
||||||
*.md \
|
*.md \
|
||||||
*.dox \
|
*.dox \
|
||||||
*.proto
|
*.proto
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,16 @@
|
||||||
## Building Doxygen Documentation
|
## Building Doxygen Documentation
|
||||||
|
|
||||||
We use [Doxygen](https://www.doxygen.nl) for our code 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
|
```bash
|
||||||
doxygen Doxyfile
|
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)
|
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).
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
## Doxygen Documentation Theme
|
## Doxygen Documentation Theme
|
||||||
|
|
||||||
|
|
|
||||||
232
doc/doxygen/images/cockatrice_logo.svg
Normal file
|
After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 398 KiB After Width: | Height: | Size: 398 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 885 B After Width: | Height: | Size: 885 B |
|
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.6 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.8 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 194 KiB |
|
Before Width: | Height: | Size: 245 KiB After Width: | Height: | Size: 245 KiB |
|
Before Width: | Height: | Size: 303 KiB After Width: | Height: | Size: 303 KiB |
|
Before Width: | Height: | Size: 278 KiB After Width: | Height: | Size: 278 KiB |
|
Before Width: | Height: | Size: 227 KiB After Width: | Height: | Size: 227 KiB |
|
|
@ -1,5 +1,9 @@
|
||||||
@mainpage Documentation
|
@mainpage Documentation
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="cockatrice_logo.svg" style="width: 300px; max-width: 100%; height: auto;">
|
||||||
|
</div>
|
||||||
|
|
||||||
Welcome to the Cockatrice code documentation.
|
Welcome to the Cockatrice code documentation.
|
||||||
|
|
||||||
- @subpage user_reference
|
- @subpage user_reference
|
||||||