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

Improvement documentation #61

Closed
ahojukka5 opened this issue Aug 29, 2015 · 5 comments
Closed

Improvement documentation #61

ahojukka5 opened this issue Aug 29, 2015 · 5 comments

Comments

@ahojukka5
Copy link
Member

Yesterday brainstorming with @TeroFrondelius.

  • "organization" front page (static), with all projects described
  • all packages in left side menu linking to the package documentation

Practical issues? Separate repo for front page?

See http://www.juliadiff.org to get ideas, they have separate repo for front page.

front_page_suggestion

@TeroFrondelius
Copy link
Member

@TeroFrondelius TeroFrondelius added this to the 0.3.0 release milestone Feb 26, 2017
@ahojukka5
Copy link
Member Author

Maybe we should try Documenter.jl. We already own juliafem.org but we need some place where we host our documentation. Github Pages is one option, another one is ReadTheDocs.

We need some special things if we want to convert Jupyter Notebooks to part of documentation as planned and not sure how to get everything set up without a virtual machine or similar.

@TeroFrondelius
Copy link
Member

Here are few solutions to process Jupyter notebooks:
https://discourse.julialang.org/t/blogging-with-julia-code-blocks/2419

@TeroFrondelius
Copy link
Member

@ahojukka5
Copy link
Member Author

We now have https://juliafem.github.io which is run based on Jekyll. I opened issue there about writing pages using notebooks, so we can close this now.

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

2 participants