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

Make API documentation available online #276

Open
medovina opened this issue Sep 9, 2024 · 1 comment
Open

Make API documentation available online #276

medovina opened this issue Sep 9, 2024 · 1 comment

Comments

@medovina
Copy link

medovina commented Sep 9, 2024

As far as I can tell, the API documentation for SFML.NET is not available online.

It looks like the build process for SFML.Net will build the API documentation using the Sandcastle project file doc/sfml.shfbproj in the SFML.Net source distribution. However, I think that will only work on Windows. I'm running Linux, so I believe I have no way to generate the API documentation myself.

I might try to install Windows in a virtual machine to run the build process, but that's a bother. It would be much more convenient if the API documentation was simply available at some URL.

@eXpl0it3r
Copy link
Member

See also #275

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

No branches or pull requests

2 participants