Installation¶
Local Install¶
The extension is a single file (sphinx_codefence.py) so the easiest thing to do is grab it and put it somewhere that sphinx can find it. For example, we can follow the recommendations of the sphinx documentation hello world extension. If your sphinx document tree looks like this:
├── build
├── Makefile
└── source
├── conf.py
├── index.rst
├── _static
└── _templates
Then add a directory _ext to source/ and put sphinx_codefence.py in it:
├── build
├── Makefile
└── source
├── conf.py
├── _ext
│ └── sphinx_codefence.py
├── index.rst
├── _static
└── _templates
Now update your conf.py with:
import os
import sys
# Add the local extension directory to the python path
sys.path.insert(0, os.path.abspath('./_ext'))
# include the condefence parser monkeypatch
extensions = [
"sphinx_codefence"
]