Fix warnings in sphinx and enforce tox to fail on warnings #184
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.