Skip to content

Conversation

@kohlerca
Copy link
Collaborator

@kohlerca kohlerca commented Nov 6, 2025

This PR fixes some errors during the documentation build process:

  1. The docs test job and the ReadTheDocs build job in the CI are based on environment-docs.yml, which specifies python>=3.8. However, the test job sets the environment to Python 3.12, while ReadTheDocs tries to build the documentation on Python 3.14, which is causing errors. The first fix in this PR is to set the Python version in environment-docs.yml to 3.12, ensuring both CI jobs are consistent and the documentation build runs without error.
  2. Small errors in docstring formatting that generated Sphinx warnings during the build were fixed.
  3. The HTML page generated for the UE tutorial notebook was missing a user-defined function for plotting, due to an explicit request for NbSphinx to hide the cell. It was replaced by the equivalent Viziphant function.

@coveralls
Copy link
Collaborator

coveralls commented Nov 6, 2025

Coverage Status

coverage: 88.303%. remained the same
when pulling fca18cc on INM-6:fix/ci_docs_python_version
into 066c48d on NeuralEnsemble:master.

@kohlerca kohlerca changed the title [Fix] CI errors for documentation [Fix] Documentation build errors Nov 6, 2025
@kohlerca kohlerca marked this pull request as ready for review November 6, 2025 13:03
@kohlerca kohlerca added build Travis, libraries, package versioning documentation Indicates a need for improvements or additions to documentation bugfix Fix for an indentified bug. maintenance labels Nov 6, 2025
@kohlerca kohlerca requested a review from mdenker November 6, 2025 13:05
Copy link
Member

@mdenker mdenker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks all good to me.

@mdenker mdenker merged commit 5392583 into NeuralEnsemble:master Nov 11, 2025
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Fix for an indentified bug. build Travis, libraries, package versioning documentation Indicates a need for improvements or additions to documentation maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants