-
-
Notifications
You must be signed in to change notification settings - Fork 219
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
[Docs] Generate API Reference on build action #43
Comments
Hi, I love blender and all the nodes based programs. I created a new workflow for now as followes
and it creates the correct documentation, but the thing is that it is creating that in html formatt and not in markdown.
if anyone knows a fix for this please let me know |
Hi! Did you try following the guide? https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet |
Yes, I followed that guide but it was no good. |
This may be helpful: dotnet/docfx#684 (comment) |
FYI documentation is now stored in a docs folder that's synchronized to the wiki on push to master (related: #113) |
Hey, there I want to fix this issue:
dotnet tool install -g docfx
{
"metadata": [
{
"src": [
{
"files": ["**/*.csproj"],
"exclude": ["**/bin/**", "**/obj/**"]
}
],
"dest": "obj/api",
"filter": "filterConfig.yml"
}
],
"build": {
"content": [
{
"files": ["obj/api/**/*.yml", "toc.yml"]
}
],
"dest": "docs",
"output": "markdown",
"template": ["default"]
}
}
apiRules:
exclude:
- type: Exclude
uidRegex: ^((?!Nodify).)*$
{% if item.summary %}
<summary>{{ item.summary | link_external }}</summary>
{% endif %}
name: Build Documentation
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install DocFX
run: dotnet tool install -g docfx
- name: Build Documentation
run: |
docfx metadata
docfx build --serve
- name: Deploy to Wiki
run: |
# Add logic to push the markdown to GitHub Wiki |
Describe the issue
Find a way to generate API Reference from XML comments in the build pipeline (GitHub action) and upload it to the wiki.
Please make sure that documentation is generated only for types inside Nodify.dll and that links to WPF classes are pointing to the Microsoft documentation (e.g. references to FrameworkElement will point to this https://learn.microsoft.com/en-us/dotnet/api/system.windows.frameworkelement?view=windowsdesktop-6.0)
Additional context
The API Reference was previously generated manually with a custom tool and uploaded to the website but that tool had multiple issues and it could not be used in a pipeline.
The text was updated successfully, but these errors were encountered: