3dcitydb-docs
3dcitydb-docs copied to clipboard
3dcitydb
Prepare release v5.0
Let's use this issue to prepare the check-list for the v5.0 release
Todo:
- [x] Create new branch for the release (release-v5.0)
- [ ] Update template/build process if needed
When the list is complete, we can assign tasks.
I would say wait until the beginning of next week to close the issue and proceed
Do we really need to update Sphinx? There is no version specified in the requirements.txt file. So the most recent is always used.
@clausnagel Now we need to specify whether we need an update and if so, which one.
@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, @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.
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.
