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

Prepare release v5.0 #49

Open
1 of 2 tasks
dokgeppo opened this issue Nov 5, 2024 · 7 comments
Open
1 of 2 tasks

Prepare release v5.0 #49

dokgeppo opened this issue Nov 5, 2024 · 7 comments

Comments

@dokgeppo
Copy link

dokgeppo commented Nov 5, 2024

Let's use this issue to prepare the check-list for the v5.0 release

Todo:

  • Create new branch for the release (release-v5.0)
  • Update template/build process if needed

When the list is complete, we can assign tasks.

@dokgeppo
Copy link
Author

dokgeppo commented Nov 5, 2024

I would say wait until the beginning of next week to close the issue and proceed

@dokgeppo
Copy link
Author

dokgeppo commented Nov 6, 2024

Do we really need to update Sphinx?
There is no version specified in the requirements.txt file. So the most recent is always used.

@dokgeppo
Copy link
Author

dokgeppo commented Nov 6, 2024

After talking with @SchultzeMax I have created the branch.

@SchultzeMax
Copy link

@clausnagel Now we need to specify whether we need an update and if so, which one.

@clausnagel
Copy link
Member

@dokgeppo, @SchultzeMax, thanks for your feedback. Sounds good that we are already on the latest Sphinx version. I think we wanted to move to a new document template. And another question was whether the Sphinx environment files (config, make, ...) can/should be cleaned up or must be adapted.

@dokgeppo
Copy link
Author

dokgeppo commented Nov 6, 2024

@dokgeppo, @SchultzeMax, thanks for your feedback. Sounds good that we are already on the latest Sphinx version. I think we wanted to move to a new document template. And another question was whether the Sphinx environment files (config, make, ...) can/should be cleaned up or must be adapted.

I think we can start with the documentation and keep the discussion on the new template in an another issue.

@BWibo BWibo self-assigned this Nov 6, 2024
@BWibo
Copy link
Member

BWibo commented Nov 6, 2024

Hey all,
I will contribute the Docker part of the documentation. I can also offer to add Github workflows for build and deployment.

Dependency updates

If we continue to use sphinx-rtd-theme, we should update Sphinx as the recently released v.3.x brings support for newer Sphinx and docutils versions (see here).

Switch to another theme

We should collect what our requirements to the new documentation are. For instance, do we want to have functionality provided by ReadTheDocs to switch between versions or translations?
A question that come along with this topic is where we want to host the documentation and how the build process and deployment should work.

I personally moved my technical documentations to a different build system (https://squidfunk.github.io/mkdocs-material/), mainly because I'm not very happy with the search functionality provided by Sphinx + RTD and the slow build time.

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

6 participants