Skip to content

Rest 49: Documentation using Automation Tool DocFX #15

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
Merged
merged 9 commits into from
Sep 12, 2023
Merged

Rest 49: Documentation using Automation Tool DocFX #15

merged 9 commits into from
Sep 12, 2023

Conversation

ujj-s
Copy link
Contributor

@ujj-s ujj-s commented Jun 20, 2023

DocFX Tool

  • DocFx tool can be used to automate the documentation process and can be used to create good Static Documentation file
  • The tool must be installed and configured to the project using docfx.json file and the necessary code must be added depending on the class library or .net api project

Updates

  • Added the XML Documentation to the all the code files so that the DocFx can document by generating the HTML files
  • The _site/10.0.2/api contains all the HTML files and contains a toc.html file that contains link to all the files in one

sameer-s-b
sameer-s-b requested changes Jun 23, 2023
View reviewed changes
@sameer-s-b sameer-s-b merged commit a35d78b into OsmosysSoftware:main Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sameer-s-b sameer-s-b sameer-s-b approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ujj-s @sameer-s-b @ujjawalosmosys