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

Cannot display pseudo-code correctly #18

Open
LuciusMos opened this issue Jul 27, 2022 · 5 comments
Open

Cannot display pseudo-code correctly #18

LuciusMos opened this issue Jul 27, 2022 · 5 comments

Comments

@LuciusMos
Copy link

Hi, thank you very much for developing such a useful tool.

However, I copied the quicksort example, but it cannot display correctly:
image

I have:

  • installed sphinxcontrib-pseudocode==0.7.0, and my python version is 3.8.11
  • add sphinxcontrib.pseudocode in extensions in conf.py

Besides, my sphinx related libraries versions are:

sphinx-autobuild==2021.3.14
sphinx-autodoc-typehints==1.11.1
sphinx-copybutton==0.5.0
sphinx-jinja2-compat==0.1.2
sphinx-markdown-tables==0.0.15
sphinx-prompt==1.5.0
sphinx-rtd-theme==1.0.0
sphinx-tabs==3.2.0
sphinx-toolbox==2.18.1
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-httpdomain==1.8.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-pseudocode==0.7.0
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
@xxks-kkk
Copy link
Owner

xxks-kkk commented Aug 4, 2022

@LuciusMos Thanks for the kind words. There are two ways to troubleshoot:

  1. You can inspect the web page and see what's the rendering errors are.
  2. You can checkout docs of this repo, which itself is a sphinx-doc containing demos of the extension. You can try to incrementally add your other extensions and see if there is any conflict. Please let me know if you identified any. I'm happy to take a closer look.

@TheAxeC
Copy link

TheAxeC commented Aug 5, 2022

It seems that numfig = True is a necessity within the conf.py file

If you remove that line from the docs of this repo (line 112 in the conf.py file), it will also stop working.

@TheAxeC
Copy link

TheAxeC commented Aug 5, 2022

In addition, there seems to be an issue when Sphinx imports (or automatically finds) rst files.

For example, in the docs from this repo, the page generated for demo.rst will not properly work (only the base index.html works) even though demo.rst gets included within index.rst.

@njulhy
Copy link

njulhy commented Aug 31, 2022

It seems that numfig = True is a necessity within the conf.py file

If you remove that line from the docs of this repo (line 112 in the conf.py file), it will also stop working.

solved my problem, thx

@igormcoelho
Copy link

I can confirm that numfig = True in conf.py also solved my problem. Thanks!

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

No branches or pull requests

5 participants