gddoc2yml 0.0.1

Convert godot xml docs to docfx yml

Godot Doc 2 Yml

Convert godot xml docs exported via the godot --doctool for gdscript to yml compatible with docfx.

References

• Godot -- CLI Reference
• Godot -- make_rst.py
• DocFx -- Github
• DocFx -- Introduction to Multiple Languages Support

Setup

Build package

# Install dependencies
python3 -m pip install -r requirements.txt

# Install build if required
# python3 -m pip install build
# Project will be created in dir dist
python3 -m build

Linting

Lint using flake8 tool.

# Run flake8 from .flake8 config file
# Install via python3 -m pip install flake8
flake8 .

Tests

Run tests for project via Python's unittest module -- Unit testing framework

python3 -m unittest

Code Coverage

Compute code coverage using coveragepy

# Get code coverage using coverage
# Install via python -m pip install coverage
coverage run -m unittest discover

# Get results
coverage report -m

Example

Build godot docs using latest gddoc2yml.

# Install from repo
python3 -m pip install .

# Generate docs using gdxml2yml
gdxml2yml godot/doc/classes doc/api

# Startup docfx website
dotnet tool run docfx --serve doc/docfx.json