Commit 1d3a6fe9 authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Update documentation build instructions

parent 01261f86
Pipeline #38501 passed with stages
in 5 minutes and 57 seconds
......@@ -48,7 +48,7 @@ different names.
3. Install python virtualenv to be able to have python virtual environments:
.. code:: shell
$ sudo dnf install python3-virtualenv python3-virtualenv-api python3-virtualenv-clone python3-virtualenvwrapper python3-pytest-virtualenv``
$ sudo dnf install python3-virtualenv python3-virtualenv-api python3-virtualenv-clone python3-virtualenvwrapper python3-pytest-virtualenv
Install instructions for Linux systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -173,11 +173,25 @@ The older commit history of the energy operators code can be found here: https:/
Documentation
~~~~~~~~~~~~~
To build locally the documentation of `tkwantoperator`, few additional (on top of the ones needed in :ref:`install`) python packages are required:
To build locally the documentation of ``tkwantoperator``, few additional (on top of the ones needed in :ref:`install`) python packages are required, please note that these packages should be installed in the same virtual environment as ``tkwantoperator``, if one is used (so they can find the module ``tkwantoperator``):
.. code:: shell
$ pip3 install sphinx jupyter-sphinx
$ pip3 install sphinx jupyter-sphinx setuptools_scm sphinx_autodoc_typehints
Latex is also needed to display pretty legends and axis titles in the generated matplotlib plots:
* Ubuntu
.. code:: shell
$ sudo apt install texlive-latex-extra cm-super-minimal dvipng
* Fedora
.. code:: shell
$ sudo dnf install texlive-scheme-medium
The documentation can then be build directly in the ``doc`` folder of the
local tkwantoperator source code repository from the command line:
......
......@@ -44,7 +44,7 @@ extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'jupyter_sphinx.execute',
'jupyter_sphinx',
'kwantdoc',
]
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment