search

CaseyHofland / docfx-unitypackage

DocFX Unity package is a GitHub action for deploying a DocFX website for Unity packages to GitHub Pages.
https://github.com/marketplace/actions/docfx-unitypackage
MIT License
21 stars 8 forks source link

ability to specify a defined docfx.json #2

Closed StephenHodgson closed 1 year ago

StephenHodgson commented 1 year ago

It'd be great to be able to specify a pre-defined docfx.json file to use when generating doc content

CaseyHofland commented 1 year ago

I've opted against this for the sake of staying accurate to the DocTools. I want this tool to stay similar to Unity's documentation workflow so that, in case they ever release their tool, switching over is painless.

However, I do acknowledge that "removing one file" isn't exactly painful. I'm just anxious to do it as I'm still finding that line. Could you tell me what problem this functionality would solve for you?

StephenHodgson commented 1 year ago

Oh, I didn't know there was a useful package for this! thanks!

Is this link for DocTools in the main readme?

CaseyHofland commented 1 year ago

There is a link in the readme under "Usage".

Do note that I am not affiliated with the DocTools. The DocTools are an internal Unity package that is not made openly accessible. docfx-unitypackage just uses the same workflow.