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

CI to Generate On-line Documentation and Examples? #1305

Closed
smiths opened this issue May 10, 2019 · 4 comments
Closed

CI to Generate On-line Documentation and Examples? #1305

smiths opened this issue May 10, 2019 · 4 comments
Assignees

Comments

@smiths
Copy link
Collaborator

smiths commented May 10, 2019

@Mornix, how difficult would it be to automatically generate an on-line web-page that shows our Haddock documentation and our case study examples? I've never done it, but my understanding is that part of the continuous integration script can keep a web-page up to date. What I'm thinking is that we could make our web-page more impressive to external visitors if we had more information for them, without them having to install stack and run make. We could post the following:

  • our Haddock documentation
  • our case studies

I'm thinking that it might be possible to put this material in the Wiki, or maybe there is another place for generated html?

We have discussed having a more impressive web-page in the past, and this seems to me to be a relatively easy way to take a step in that direction. Since the generated documentation and case studies will always be up to date with master, they might even be a resource we use to quickly look something up.

If this is relatively easy to do, we might change the label for this issue from Question to Enhancement, but we'd need to see what @JacquesCarette thinks.

@JacquesCarette
Copy link
Owner

Sure seems like a good idea to me!

@Mornix
Copy link
Collaborator

Mornix commented May 10, 2019

I believe this should all be possible and shouldn’t require too much effort. CI currently builds all of these artifacts and throws them away at the end. I was thinking of hosting this sort of documentation with the master branch for the visual diff idea I’ve been playing with.

@smiths
Copy link
Collaborator Author

smiths commented May 10, 2019

Thank you @Mornix. That is the answer I was hoping for. 😄 I'm glad to see that @JacquesCarette is also behind this idea. I'm going to change this question into an Enhancement.

@Mornix
Copy link
Collaborator

Mornix commented Jul 11, 2019

Completed with merge #1474. Followup is #1412.

@Mornix Mornix closed this as completed Jul 11, 2019
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