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.

Sign up for GitHub

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

Jump to bottom

Publish code documentation #1

Open
berezovskyi opened this issue Apr 15, 2017 · 4 comments
Open

Publish code documentation #1

berezovskyi opened this issue Apr 15, 2017 · 4 comments
Labels
area:docs help wanted kind:enhancement tag:CodePlex

Comments

@berezovskyi
Copy link
Member

mffiedler[CodePlex]
Create some initial API documentation using XML comments
@berezovskyi
Copy link
Member Author

I vaguely remember using https://github.com/EWSoftware/SHFB when I did C# development.

@berezovskyi
Copy link
Member Author

NodaTime uses https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html

@berezovskyi
Copy link
Member Author

Should consider https://dotnet.github.io/docfx/ but it requires .NET 6+ to work.

@berezovskyi berezovskyi changed the title Create basic API XML documentation Publish code documentation Apr 18, 2023
@berezovskyi
Copy link
Member Author

.NET 6.0+ is now supported, DocFX adoption is unblocked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:docs help wanted kind:enhancement tag:CodePlex
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@berezovskyi