Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate a browsable documentation center #1556

Open
hakusaro opened this issue Dec 11, 2017 · 8 comments
Open

Automatically generate a browsable documentation center #1556

hakusaro opened this issue Dec 11, 2017 · 8 comments

Comments

@hakusaro
Copy link
Member

Like other civilized projects, every build should tigger automatic building and production of API documentation for TShock & TSAPI.

  1. Identifying which documentation system we should go with.
  2. Creating a script to build said documentation. (And god let it be better than a python script as far as "can run instantly on every platform" goes).

My ideal system is a static file generator that is super easy to run that produces self contained HTML. That way, we can host it on GitHub pages and rig the build system to automatically deploy docs for each branch, just like we do with Travis builds.

@QuiCM
Copy link
Member

QuiCM commented Dec 14, 2017

I found something the other day that would have been good for this, but now I've forgotten what it was.
Watch this space

@QuiCM
Copy link
Member

QuiCM commented Dec 14, 2017

Here it is. http://dotnet.github.io/docfx/

@hakusaro
Copy link
Member Author

Built by MSFT, so lgtm.

@Olink
Copy link
Contributor

Olink commented Dec 21, 2017

I've used Doxygen for C# in the past. I assume DocFX lets us get the same functionality but Doxygen lets you write custom handlers (I've used this for documenting API routes and permissions in a ASP project derived from attributes on the method instead of slapping it in the xmldoc).

DocFx looks more flexible. LGTM.

@AxisKriel
Copy link
Member

Had a brief look at DocFx, and it's LGTM.

@QuiCM
Copy link
Member

QuiCM commented Dec 27, 2017

Marking this as WIP as we will be going with DocFX at some point in the future

@hakusaro
Copy link
Member Author

Tried to get docfx working on Mac with Mono. I was able to generate the project but can't actually serve the website because it seems to want to be able to find msbuild.dll, which apparently doesn't ship with homebrew's mono.

I don't think I'm going to fight mono again, so I'll let someone else deal with this one.

@QuiCM
Copy link
Member

QuiCM commented Oct 31, 2018

DocFX still seems like a good option. Would help resolve things like #1572.
Marked as pending because no one is working on this afaik

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants