Quick Start¶
Installation¶
Download and unpack:
$ curl -O https://codeload.github.com/veit/pyviz-tutorial/zip/refs/heads/main $ unzip main Archive: main … creating: pyviz-tutorial-main/ …
Install Pandoc:
for Ubuntu and Debian:
$ sudo apt install pandoc
for macOS:
$ brew install pandoc
Install Python packages:
$ cd pyviz-tutorial $ python3 -m venv .venv $ . .venv/bin/activate $ python -m pip install -e ".[dev]"
Create HTML documentation:
$ python -m sphinx -b html docs/ docs/_build/html/
Create PDF:
You will need additional packages to create PDFs.
For Debian/Ubuntu you can get these with:
$ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
or for macOS with:
.. code-block:: console
$ brew cask install mactex … 🍺 mactex was successfully installed! $ curl –remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts $ sudo texlua install-getnonfreefonts … mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R… mktexlsr: Done.
You can then generate a PDF with:
$ cd docs/ $ make latexpdf … The LaTeX files are in _build/latex. Run 'make' in that directory to run these through (pdf)latex …
You will then find the PDF in
docs/_build/latex/pyviz-tutorial.pdf
.
Follow us¶
Pull-Requests¶
If you have suggestions for improvements and additions, I recommend that you create a fork of my GitHub repository and make your changes there. You are also welcome to submit a pull request. As long as the changes are small and atomic, I will be happy to look at your suggestions.