sphinx-contrib / email Goto Github PK

in #18 I set up everything fo package coverage using codecov, once it get merge would you like to create a codecov token and add it to github actions so that we run the last piece of the unit.yaml file ?

at the moment the role is only meant to be used in html builder as it launch a raw docutils node.
What about making it compatible with others ? by linking it to existing node (as the obfuscation is obviously not needed in pdf)

everything is in the title

In #18, I set up some unit tests using a pre-commit github actions. It takes 5s to run on github and avoid relying on multiple CI/CD plugin.
Also note that ruff/flake8 make pre-commit fails without automatic fix meaning that pre-commit.ci is just failing like a normal action without providing automatic solutions.

comf.py:

email_automode = True

file.rst:

Header 1
--------

This is an email address [email protected], sure.


Header 2
--------

More text.

STDOUT:

Handler <function html_page_context_handler at 0x00000200D381E550> for event 'html-page-context'
threw an exception (exception: Multiple elements found (div, div))

Hi,

I noticed that your extension doesn't work properly in a Vue-based theme (for example: Sphinx Press theme)). The script tag generated by the library causes a JS error in the Vue which results in the white page. This issue is mentioned here: https://stackoverflow.com/questions/69514098/writing-javascript-code-in-a-component-using-vue

I think the best would be to add extra configuration property that lets the extension know that Vue is used.

Hi, the v0.1 which is pip-installed with Python 3.6 fails with

  File ".../VirtualEnv/Python3.6/lib/python3.6/site-packages/sphinxcontrib/email.py", line 15, in <module>
    rot_13_trans = string.maketrans(
AttributeError: module 'string' has no attribute 'maketrans'

but later versions only support Python 3.7+.

As the title suggests, your code fails at string.maketrans as this has been deprecated. Please update to use str.maketrans.

I got this error when trying to build my docs in parallel mode using -j auto:

WARNING: the sphinxcontrib.email extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit
WARNING: doing serial read

It seems pretty straightforward, but I don't know much about writing extensions: https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata

Thanks !