-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs: build documentation using mkdocs #253
Conversation
@JantineSmit What is the status of this PR? Is it ready for review? If so, can you click "Ready for review" (above them comment section at the bottom of the page) and mark me as reviewer? |
c72d5c9
to
ca3c7dd
Compare
ca3c7dd
to
512e3c6
Compare
I have taken the liberty to:
|
I have updated the docs with:
|
42df0bf
to
181cf56
Compare
Probably, pyyaml was a dependency of sphinx, but not explicitly of eitprocessing.
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.
I think this is a great effort that improves the documentation significantly. I have made some changes to make the API page more accessible.
I have already deployed the new documentation to the github.io page. This should from now on be done automatically every time a release is made. There is no way to test this definitively without making a release, so we'll see whether that works the next time we make a release after this PR is merged.
@JantineSmit If you agree with these changes you can go ahead and merge the PR.
Great! Deployment of the documentation went as planned, so it should update every time we release a new version. |
@JantineSmit, I created a draft pull request for your documentation building branch.
Once you feel it is ready (to be reviewed), you can click "Ready to review" below and tag me (and @psomhorst?) as a reviewer.
closes #233