summaryrefslogtreecommitdiff
path: root/doc/development_guide/documentation.rst
blob: 4e09fcf63246b6833cec46ea21653b180706d26d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.. -*- coding: utf-8 -*-
==============
 Building the documentation
==============

When you would want to build the documentation for your self, you certainly can. Here's how...

The bare minimum
----------------

.. sourcecode:: bash

  $ python3 -m virtualenv venv
  $ . venv/bin/activate
  $ pip install Sphinx
  $ git clone https://github.com/PyCQA/pylint
  $ cd pylint
  $ python3 setup.py install
  $ cd doc
  $ make html