tpierrain/NFluent

Find the best solution to generate documentation on our CI

Opened this issue · 6 comments

Find the best solution to generate documentation on our CI
rhwy commented

the question is find best to generate doc from our code or we have a doc generator tool but find a way to make it work on CI ?

Since we are updating the build process, my idea is to identify state of art documentation generation for .Net components.

Actually, it's about finding the easiest tool (I like simple-to-use/integrate tools; I'm tired of spending time on integration and build scripts since dotnet core introduction ;-)

rhwy commented

maybe the best actually should be to have a look on asp.net docs, clone the repo and pick their scripts. it takes a mix of writtten md files and autogenerated api and ready to publish on readthedocs. That can be an easy and good solution

Sounds like a good idea. Thanks @rhwy !

Alternativey, we can use 'readthedocs', as it is growing as the de-facto standard.