Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 523acccb00
Branches Tags
gui-cs.Terminal...
/
docfx
Charlie Kindel d1c53a3147 added docfx readme 5 years ago
..
articles c4e632dc89 fixing accidental deletion of articles. oops! 5 years ago
images deaa17fd4f updated docs to match new layout 5 years ago
templates 14f08a8d63 Updated docfx. Generated fresh docs. Added an icon. 5 years ago
README.md d1c53a3147 added docfx readme 5 years ago
docfx.json e87b56cd77 updated api docs; implemented inheritdoc; may break deploy 5 years ago
index.md 46e5fdac84 updated relnotes, regenerated ddocs, inheritdoc tool now runs only on RELEASE builds 5 years ago
sample.gif a2495510cd update readme to match new doc links 5 years ago
sample.png 3d984fae1a updated README 5 years ago
toc.yml deaa17fd4f updated docs to match new layout 5 years ago

README.md

This folder generates the API docs for Terminal.Gui

To Generate the Docs

  1. Do a Release build on master. This will cause all /// <inheritdoc/> references to be updated.
  2. Change in to the docfx/ directory.
  3. Type docfx --metadata to generate metadata
  4. Type docfx --serve to generate the docs and start a local webserver for testing.

If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.