-
Notifications
You must be signed in to change notification settings - Fork 49
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
Migrated documentation from Jupyter to Documenter.jl #127
Conversation
…re learning section
# Conflicts: # doc/src/usage.md
merge into master
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor change requested.
README.md
Outdated
@@ -2,6 +2,6 @@ | |||
|
|||
This library supports representation, inference, and learning in Bayesian networks. | |||
|
|||
Please read the [documentation](http:https://nbviewer.ipython.org/github/sisl/BayesNets.jl/blob/master/doc/BayesNets.ipynb). | |||
Please read the [documentation](https:https://dwijenchawra.github.io/BayesNets.jl/dev/index.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be updated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
There is a test for documentation that looks for the old Jupyter notebook, is that still necessary? The old notebook was moved to the docs folder for easy access, should it remain there or be deleted? |
Cool. I'm good to merge. I was thinking it would be good to have @tawheeler do a quick skim before merging. |
Maybe keep the notebook there for testing purposes. It helps with code coverage. We can move the tests later on. |
Moving to Documenter.jl is a really good idea. I like that images can be generated from the markdown. Thanks! |
It looks like there is a failure here according to travis:
Can we make sure that file is added back? Once that's done, let's get this merged! |
There was a refactor needed in the tests files, we changed the name of the doc folder to docs because thats the way it was structured in both FreudenthalTriangulation and the Documenter docs. Both builds have passed now so I think we are good to go as well! |
Migrated docs to Documenter.jl and updated github deployment workflows.