question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add support for the math directive

See original GitHub issue

I am not sure if this is the right place to ask, but I haven’t seen any valuable information that would solve my problem anywhere.

I have an issue with uploading a package on PyPI. Specifically, the .rst description of my project https://pypi.org/project/challenge.uccs/ does not render on the PyPI front page.

According to their recommendation: https://packaging.python.org/guides/making-a-pypi-friendly-readme/ I installed readme_renderer version 21.0 via pip. When I run the renderer on my local copy of the project, I get the message:

$ python setup.py check -r -s
running check
The project's long description is valid RST.

So, there is no error message here, I don’t see any error message when uploading to PyPI.

Since all the required information should be online (just download the package that I pointed to), maybe you can help me in assessing why the PyPI page does not render.

Thanks for your help in advance. Manuel

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:2
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
siebenkopfcommented, Aug 1, 2018

Actually, I have added the docutils.conf in order to suppress the warning (I don’t remember where I read that I should do this). However, the docutils.conf is also part of the python package uploaded to PyPI (it is mentioned in the MANIFEST.in).

Apparently, PyPI does not use this file when rendering the documentation. I am not sure, though, how I would fix the mathjax issue otherwise. Do you have any idea?

0reactions
ankostiscommented, Mar 29, 2020

Why not file an issue at warehouse so as to comply with the setting in the docutils.conf file, if it is present at the root of some package?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Math support in Sphinx — Sphinx 1.2 (hg) documentation
Directive for displayed math (math that takes the whole line for itself). The directive supports multiple equations, which should be separated by a...
Read more >
Math support for HTML outputs in Sphinx
Since mathematical notation isn't natively supported by HTML in any way, Sphinx gives a math support to HTML document with several extensions.
Read more >
using directive - C# Reference - Microsoft Learn
The global using directive was added in C# 10. ... By eliminating the need to explicitly reference the Math class each time a...
Read more >
reStructuredText Directives - Docutils - SourceForge
The "figure" directive supports all of the options of the "image" directive (see ... The "math" directive inserts blocks with mathematical content (display ......
Read more >
Make directives and roles for math to sphinx-core · Issue #4333
I think policy of Docutils to insert contents verbatim if output format does not support natively math input is fine. And that it...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found