mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-11 20:43:25 -08:00
b64e168026
Upstream moved the documentation sources from doc/ to docs/ (#7584), so the page this branch adds now belongs under docs/doxygen/pages/user_documentation/ gameplay/. The index.md edit auto-merged onto the moved file, but the new page stayed at the old path, and GitHub's merge engine reported a conflict in index.md because the file it edits was deleted upstream. No source changes: the merge is upstream/master as-is plus the doc relocation. |
||
|---|---|---|
| .. | ||
| css | ||
| filters | ||
| groups | ||
| html | ||
| images | ||
| js | ||
| pages | ||
| theme@46483f1e5a | ||
| DoxygenLayout.xml | ||
| README.md | ||
Building Doxygen Documentation
We use Doxygen for our code documentation.
After installing the tool, you can build a HTML webpage into the /docs-output folder according to our configuration:
doxygen Doxyfile
Open the index.html file in the /docs-output/html/ folder to browse the result locally.
There is also an online version we host at the Cockatrice webpage: cockatrice.github.io/docs
Doxygen's own documenation can be found at www.doxygen.nl/manual.
Doxygen Documentation Theme
Required changes to the Doxyfile config from the theme docs to make doxygen-awesome-css work:
HTML_EXTRA_STYLESHEET = doxygen-awesome.css # Main CSS file of the theme
GENERATE_TREEVIEW = YES # Optional, also works without
HTML_COLORSTYLE = LIGHT # Required with doxygen-awesome-css theme, Auto Dark Mode will still work
DISABLE_INDEX = NO # YES is bugged in the theme, see jothepro/doxygen-awesome-css/issues/201
FULL_SIDEBAR = NO # Required for doxygen-awesome-css theme
Cockatrice dedicated color adjustments are configured in the cockatrice_docs_style.css file that uses & overrides the theme definitions.