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

[C#] Show API docs on arrow.apache.org #25485

Open
asfimport opened this issue Jul 10, 2020 · 3 comments
Open

[C#] Show API docs on arrow.apache.org #25485

asfimport opened this issue Jul 10, 2020 · 3 comments

Comments

@asfimport
Copy link

We should use the XML documentation files that are generated during the build and publish them to arrow.apache.org under the Documentation tab.

One option would be to use https://ejball.com/XmlDocMarkdown/ to generate a markdown file, which could be displayed as a web page.

Another would be to use https://dotnet.github.io/docfx/.

Reporter: Eric Erhardt / @eerhardt

Note: This issue was originally created as ARROW-9406. Please see the migration documentation for further details.

@asfimport
Copy link
Author

Kouhei Sutou / @kou:
We're generating documents by https://github.com/apache/arrow/blob/master/ci/scripts/docs_build.sh .
If we can generate HTML documentation for C#, we will be able to use it in docs_build.sh easily.

@asfimport
Copy link
Author

Joris Van den Bossche / @jorisvandenbossche:
There might be some projects to plug the XML into sphinx, but the ones I found from just googling (I am not familiar with C# otherwise) don't seem very active: https://github.com/readthedocs/sphinxcontrib-dotnetdomain, https://hach-que.github.io/SphinxForDotNet/ (https://github.com/hach-que/SphinxForDotNet)

@asfimport
Copy link
Author

Neal Richardson / @nealrichardson:
It's trivial (if the docs exist) to add links to them to the existing sphinx docs and website. We do this for other languages already.

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

1 participant