We write here miscellaneous tips and tricks.
Python 3 can be used in a dedicated virtualenv in Ubuntu 18.04 as follows:
python3 -m venv sphinx
Then enter the environment
Install the following python packages:
This can be done with the command
pip install sphinx sphinxcontrib-matlabdomain texext guzzle_sphinx_theme sphinx-togglebutton sphinxcontrib-fulltoc ablog
(add the option
--user if not installing inside a virtual environment)
For the Jupyter notebooks:
In particular, install the Python package nbsphinx, and the Ubuntu package pandoc
Then install also the project requirements by running the following command within the ‘sphinx’ folder:
pip install -r requirements.txt
Proof environment? https://framagit.org/spalax/sphinxcontrib-proof/
Scripts such as
replab_generate live in the fake
root package, so these references look actually like
root prefix is stripped when displayed on the console. In the Sphinx documentation, one should use the
Jupytext works fantastically well.
Running the Matlab kernel from within a Matlab session does not work. We sidestep this problem by using the Octave kernel in all Jupyter notebooks.