Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 1.33 KB

README.md

File metadata and controls

79 lines (55 loc) · 1.33 KB

CrafterCMS documentation.

Requirements

Install Python & PIP & pipenv

First, you need to install Python 3 and PIP (if not already present on your system):

sudo apt-get install python3-pip

You might need to update PIP right away

pip3 install -U pip

Then, install pipenv

sudo pip install pipenv

Finally, install dependencies

pipenv install

and activate the pipenv shell

pipenv shell

Install Extensions

Install the following required extensions

Building CrafterCMS documentation

After meeting all requirements, you're ready to build the docs by running this command:

make html

The docs will be under build folder.

To clear the build folder run

make clean

NOTE Remember that when building the docs you need to activate the pipenv shell.