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

ReadTheDocs versioning #71

Open
ewoutkramer opened this issue Oct 3, 2024 · 0 comments
Open

ReadTheDocs versioning #71

ewoutkramer opened this issue Oct 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ewoutkramer
Copy link
Member

Add versioning to ReadTheDocs of Firely .NET Docs.

Also try to have the API documentation in ReadTheDocs.

Already done

Make sure you have .NET SDK installed, then open a terminal and enter the following command to install the latest docfx:

dotnet tool update -g docfx

Use the following docfx.json:

{
  "metadata":[ {
    "src": [
      {
        "files": ["**/Hl7.Fhir*.csproj"],
        "exclude": ["**/obj/**", "**/bin/**", "**/BenchMarks/**", "**/Hl7.Fhir*Tests/**"],
        "src": "../src"
      }
    ],
    "dest": "api",
    "properties": {
      "TargetFramework": "netstandard2.0"
  }
  }
  
],
  "build": { 
    "content": [{
      "files": [ "api/*.yml" ]
    }]
  }
}

Place the above json in folder <SDK-repo>\docfx_project

Then run the following command:

docfx docfx_project/docfx.json --serve
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants