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

Get API docs built to markdown #27

Open
crazy4pi314 opened this issue Jul 27, 2020 · 4 comments
Open

Get API docs built to markdown #27

crazy4pi314 opened this issue Jul 27, 2020 · 4 comments

Comments

@crazy4pi314
Copy link
Contributor

Check to see how/what tool we can use to convert API docs to markdown files.

@crazy4pi314 crazy4pi314 added this to the Documentation Complete milestone Jul 27, 2020
@crazy4pi314 crazy4pi314 self-assigned this Jul 27, 2020
@crazy4pi314 crazy4pi314 added this to To do in qRAM library project via automation Jul 27, 2020
@amirebrahimi
Copy link
Collaborator

Have you considered docfx?

@crazy4pi314
Copy link
Contributor Author

Yeah thats what I want to use basically, but we need a way to scrape the API comments from the source. I think either myself or @cgranade might have a complier extension floating around that does that. Just need to get it documented 😄

@cgranade
Copy link

I had a pretty rough experiment at microsoft/qsharp-runtime#253, but haven't had the chance yet to move it to qsharp-compiler as suggested, or to address the feedback so far. The biggest is that the tool picks up everything from assembly references as well as the current compilation unit; as per @bettinaheim's feedback, that can be fixed by looking at the Source property to check for .EndsWith(".qs") versus .EndsWith(".dll").

@crazy4pi314
Copy link
Contributor Author

Items left after #49

  • Configure DocFX or similar to consume the Q# generated markdown
  • Get GH actions setup to build the docs and serve them as a GH pages site

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

3 participants