Get API docs built to markdown

qsharp-community / qram

Library for Q# implementing various qRAM proposals

MIT License

52 stars 17 forks source link

Get API docs built to markdown #27

Open crazy4pi314 opened 4 years ago

crazy4pi314 commented 4 years ago

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

amirebrahimi commented 4 years ago

Have you considered docfx?

crazy4pi314 commented 4 years ago

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 commented 4 years ago

I had a pretty rough experiment at https://github.com/microsoft/qsharp-runtime/pull/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 commented 4 years ago

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