BEdita documentation

This is the repository of the BEdita documentation you can see at https://bedita.readthedocs.org

Build the documentation manually

The documentation is built using Sphinx.

In order to build the documentation you need pip (the tool for installing Python packages). Recent versions of Pyhton (>= 2.7.9) already include pip. If it missing you can easily install it.

Once pip is installed, you have to move to the directory where you cloned this project

cd /dir/bedita/docs

install the project dependencies (which may require administrator access)

pip install -r requirements.txt

compile the documentation

make html

That's it.

You would see a new build directory in the root of the project. Open build/html/index.html with a browser to see the compiled documentation.