Django Filer Documentation

Run the documentation locally

Install the Enchant library

You will need to install the enchant library that is used by pyenchant for spelling.

macOS:

brew install enchant

After that:

Fork & Clone the repository:

git@github.com:your-github-username/django-filer.git

Switch to the django-filer/docs directory:

cd django-filer/docs

Install the dependencies:

make install

This command creates a virtual environment and installs the required dependencies there.

Start the development server:

make run

Open the local docs instance in your browser:

open http://0.0.0.0:8001/

The documentation uses livereload. This means, that every time something is changed, the documentation will automatically reload in your browser.

Contribute

If you find anything that could be improved or changed in your opinion, feel free to create a pull request.