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

Fix warnings in sphinx and enforce tox to fail on warnings #184

Merged
merged 2 commits into from
Jun 21, 2024

Conversation

AurelienJaquier
Copy link
Collaborator

In ecode ascii art, use `` to convert ascii into string literal and prevent sphinx to fail on it.

In sAHP, for some reason, I had to remove some | characters to prevent sphinx to fail, even though it was between ``.

Fix code blocks in docstrings.

Modified conf.py so that tox would fail on sphinx warnings, so that we could fix them and keep a full documentation.

For some reason, sometimes the documentation displays the string .. code-block:: python and sometimes it does not. I could not find the reason behind it, but it is a minor issue that I will graciously ignore.

@AurelienJaquier AurelienJaquier self-assigned this Jun 21, 2024
Copy link
Contributor

@anilbey anilbey left a comment

Choose a reason for hiding this comment

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

Great, thanks

Modified conf.py so that tox would fail on sphinx warnings, so that we could fix them and keep a full documentation.

Cool 🚀

Copy link
Contributor

@darshanmandge darshanmandge left a comment

Choose a reason for hiding this comment

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

thank you!

@AurelienJaquier AurelienJaquier merged commit 0e9654f into BlueBrain:master Jun 21, 2024
4 checks passed
@AurelienJaquier AurelienJaquier deleted the fix-docs branch June 21, 2024 15:22
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.

3 participants