sphinx-contrib / ansi Goto Github PK

LICENSE file is referenced in the doc/index.rst.
Therefore, building the docs currently fails (and that is one of the problems).

setup.py (in version 0.6) was broken after README file was renamed to README.rst.

SEE: pull-request #1

That is a tracking ticket for actions needed for bringing back the project to being actively maintained:

• @ssbarnea pypi project ownership
• @ssbarnea added as core on github. I still need admin as current permissions do not allow me to control webhooks or configuration access to branches. Related to sphinx-contrib/github-administration#13
• review and eventually merge current PRs
• configure github actions pipelines
• bring CI to green on current versions of sphinx
• configure RTD integration https://readthedocs.org/projects/sphinxcontrib-ansi/
• team up with others, collective maintenance is better

sphinxcontrib-ansi is using some old-style Sphinx APIs that are removed in Sphinx v2.x:

• app.info() (use: sphinx.util.logging)

# -- SPHINX-BUILD OUTPUT:
...
Running Sphinx v1.8.5
...
/xxx/.venv_py37/lib/python3.7/site-packages/sphinxcontrib/ansi.py:180: RemovedInSphinx20Warning: app.info() is now deprecated. Use sphinx.util.logging instead.
  app.info(bold('Copying ansi stylesheet... '), nonl=True)
Copying ansi stylesheet... 
/xxx/.venv_py37/lib/python3.7/site-packages/sphinxcontrib/ansi.py:184: RemovedInSphinx20Warning: app.info() is now deprecated. Use sphinx.util.logging instead.
  app.info('done')
...

Hopefully this is a reasonable place to ask this question:

I have some program that has terminal output with ANSI color codes that nicely display color in the terminal, but will show the literal ANSI codes in the HTML output unfortunately.
As a simple example, let's say I have some python file like this:

# -*- coding: utf-8 -*-
"""
Plot The Marvelous Colors
=========================

"""

print('\033[94m' + "hi" + '\033[0m')

then in doc after building with sphinx gallery unfortunately I get this:

�[94mhis�[0m

This can also be seen in the second-last cell here:
https://braindecode.org/auto_examples/plot_bcic_iv_2a_moabb_trial.html

Is this something that this package would try to handle? Or do you know where else I might ask?

Gettting the following error message with the add_stylesheet call, which has been deprecated in favor of add_css_file

Extension error (sphinxcontrib.ansi):
Handler <function add_stylesheet at 0x103fcadc0> for event 'builder-inited' threw 
an exception (exception: 'Sphinx' object has no attribute 'add_stylesheet')

I can submit a PR if needed.