Quick start

Installation

1. Download and unpack:

   $ curl -O https://codeload.github.com/veit/dvc-example/zip/master
   $ unzip master
   Archive:  master
   …
      creating: dvc-example-master/
   …

2. Create HTML documentation:

   $ python3 -m venv .
   $ bin/python -m pip install --upgrade pip
   $ bin/python -m pip install -r requirements.txt
   $ bin/sphinx-build -ab html docs/ docs/_build/

3. Create PDF:

   To create PDFs you need additional packages.

   For Debian/Ubuntu you can get them with:

   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

   or for Mac OS X with:

   $ 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/
   $ pipenv run 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 :file:`docs/_build/latex/dvc-example.pdf`.

Follow us

• GitHub
• Twitter
• Mastodon

Pull requests

If you have suggestions for improvements and additions, I recommend you, create a Fork of my GitHub repository <https://github.com/veit/dvc-example/>`_ and make your changes in it. You are also welcome to make a Pull request if you like. As long as the changes in it are small and atomic, I’m happy to look at your your suggestions with pleasure.