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

docs: build documentation using mkdocs #253

Merged
merged 18 commits into from
Oct 16, 2024
Merged

Conversation

DaniBodor
Copy link
Member

@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

mkdocs.yml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@psomhorst
Copy link
Contributor

@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?

@psomhorst
Copy link
Contributor

I have taken the liberty to:

  • rebase the documentation onto the newest version of main
  • squash commits
  • add a [docs] dependency, removing the mkdocs and all dependencies from [dev]

@psomhorst
Copy link
Contributor

I have updated the docs with:

  • split the API into different categories
  • streamlining README.md
  • only show installation heading on installation page
  • formatting of function signatures
  • some layout improvements

@psomhorst psomhorst marked this pull request as ready for review October 9, 2024 19:49
@psomhorst psomhorst self-requested a review October 9, 2024 19:50
Probably, pyyaml was a dependency of sphinx, but not explicitly of eitprocessing.
Copy link
Contributor

@psomhorst psomhorst left a 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.

@JantineSmit JantineSmit merged commit 4082346 into main Oct 16, 2024
4 checks passed
@psomhorst
Copy link
Contributor

Great! Deployment of the documentation went as planned, so it should update every time we release a new version.

@psomhorst psomhorst deleted the 233_documention_jwisse branch October 18, 2024 15:01
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.

Code documentation page
3 participants