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

Update configuration and dependencies for documentation #138

Merged
merged 15 commits into from
Nov 7, 2024

Conversation

WeisLeDocto
Copy link
Member

The last major update for the documentation was already one to two years ago. It was more than time to switch to newer pinned versions for sphinx and the doc dependencies. Along with this update, several improvements were brought to the docs:

  • The documentation build was switched to nitpicky mode, to better detect broken references
  • The build OS for the online documentation was updated to Ubuntu 24.04
  • Some code-blocks containing forbidden characters were corrected
  • The conf.py file was updated to include all possible parameters
  • The broken links and references found in the docs were fixed

@WeisLeDocto WeisLeDocto added the documentation Missing, incorrect or incomplete documentation label Nov 7, 2024
@WeisLeDocto WeisLeDocto self-assigned this Nov 7, 2024
@WeisLeDocto WeisLeDocto merged commit e54ff08 into develop Nov 7, 2024
16 checks passed
@WeisLeDocto WeisLeDocto deleted the docs/update_conf_and_dependencies branch November 7, 2024 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Missing, incorrect or incomplete documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant