sphinx-doc | sphinx Chinese documentation | Theme library

Use the raw directive and your code.

There's a page on the docs that teaches how to use extensions. The page is here: https://www.sphinx-doc.org/en/master/usage/extensions/index.html

In this page you have the following description:

A list of strings that are module names of extensions. These can be extensions coming with Sphinx (named sphinx.ext.*) or custom ones.

This tells you that sphinx.ext.* are the built-ins extensions (You can confirm that from here)

Basically when it states some kind of configuration, it refers to the conf.py file that is generated when you run sphinx-quickstart, which is a quick-setup command for sphinx in general (Might be a good read: https://www.sphinx-doc.org/en/master/usage/quickstart.html)

The root directory of a Sphinx collection of plain-text document sources is called the source directory. This directory also contains the Sphinx configuration file conf.py, where you can configure all aspects of how Sphinx reads your sources and builds your documentation.

Sphinx comes with a script called sphinx-quickstart that sets up a source directory and creates a default conf.py with the most useful configuration values from a few questions it asks you.

Note that, as it's built-in, it's already setupped with your sphinx project. But if you want to customize it somehow, you can use conf.py file with autodoc_* configurations (As listed here)

There are also some notes that might be useful for your case

For Sphinx (actually, the Python interpreter that executes Sphinx) to find your module, it must be importable. That means that the module or the package must be in one of the directories on sys.path – adapt your sys.path in the configuration file accordingly.

The aforementioned sphinxext-opengraph extension currently has a PR for setting the values per page. The PR is effectivley done so a new version should be released very soon.

Edit: The PR has been merged. You can now set any tag by adding field lists to the top of the page like so:

Using sed:

The issue is resolved after removing python-sphinx , the version 1.1.3 is removed and sphinx is working fine on the latest version of 4.3.1.

logs-

This answer applies to MathJax, the default mathematics renderer in HTML output.

The following setting in conf.py left-aligns all math directive content:

Sphinx components pass warnings through the logging facility, for which Sphinx defines custom adapters in sphinx.util.logging. If you use the loggers provided there, Sphinx will treat your warnings the same as its own and respect the -W flag that turns them into errors.

Your doc test has to do the same thing a user would be expected to do: define a subclass that implements do_something and instantiate that class.

This issue apparently is known and has also been posted in spatialaudio/nbsphinx#596. As it says, a temporary fix is to downgrade the version of promt-toolkit which must be lower than 3.0.0.

You can explicitly downgrade with

pip install -U "prompt-toolkit<3.0.0"

Or simply add a rule in your requirements.txt: prompt-toolkit<3.0.0. Hopefully this incompatibility issue will be addressed soon.