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

Find the best solution to generate documentation on our CI #173

Open
tpierrain opened this issue Sep 23, 2016 · 6 comments
Open

Find the best solution to generate documentation on our CI #173

tpierrain opened this issue Sep 23, 2016 · 6 comments

Comments

@tpierrain
Copy link
Owner

No description provided.

@rhwy
Copy link
Collaborator

rhwy commented Sep 23, 2016

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 ?

@tpierrain
Copy link
Owner Author

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

@tpierrain
Copy link
Owner Author

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
Copy link
Collaborator

rhwy commented Sep 23, 2016

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

@tpierrain
Copy link
Owner Author

Sounds like a good idea. Thanks @rhwy !

@dupdob
Copy link
Collaborator

dupdob commented Feb 25, 2018

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

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

No branches or pull requests

3 participants