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

Migrated documentation from Jupyter to Documenter.jl #127

Merged
merged 60 commits into from
May 5, 2021

Conversation

dwijenchawra
Copy link
Collaborator

Migrated docs to Documenter.jl and updated github deployment workflows.

Copy link
Member

@mykelk mykelk left a 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).
Copy link
Member

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@mykelk mykelk requested a review from tawheeler May 3, 2021 21:23
This was referenced May 3, 2021
@dwijenchawra
Copy link
Collaborator Author

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?

@mykelk
Copy link
Member

mykelk commented May 3, 2021

Cool. I'm good to merge. I was thinking it would be good to have @tawheeler do a quick skim before merging.

@mykelk
Copy link
Member

mykelk commented May 3, 2021

Maybe keep the notebook there for testing purposes. It helps with code coverage. We can move the tests later on.

@tawheeler
Copy link
Contributor

Moving to Documenter.jl is a really good idea. I like that images can be generated from the markdown. Thanks!

@mykelk
Copy link
Member

mykelk commented May 5, 2021

It looks like there is a failure here according to travis:

LoadError: SystemError: opening file "/home/travis/build/sisl/BayesNets.jl/doc/BayesNets.ipynb": No such file or directory

Can we make sure that file is added back? Once that's done, let's get this merged!

@coveralls
Copy link

Coverage Status

Coverage increased (+0.02%) to 85.49% when pulling 917e1ce on dwijenchawra:master into bf38251 on sisl:master.

@dwijenchawra
Copy link
Collaborator Author

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!

@mykelk mykelk merged commit f30ac46 into sisl:master May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants