https://github.com/bedita/docs

BEdita documentation
https://github.com/bedita/docs

Last synced: 21 days ago
JSON representation

BEdita documentation

• Host: GitHub
• URL: https://github.com/bedita/docs
• Owner: bedita
• Created: 2015-10-27T08:07:19.000Z (about 9 years ago)
• Default Branch: 4-cactus
• Last Pushed: 2022-04-01T20:09:45.000Z (over 2 years ago)
• Last Synced: 2024-04-10T18:11:25.092Z (9 months ago)
• Language: Python
• Size: 1.27 MB
• Stars: 2
• Watchers: 10
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BEdita documentation

[![Documentation Status](https://readthedocs.org/projects/bedita/badge/?version=latest)](http://bedita.readthedocs.org/en/latest/?badge=latest)

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](http://sphinx-doc.org/).

In order to build the documentation you need [pip](https://pip.pypa.io) (the tool for installing Python packages).

Recent versions of Pyhton (>= 2.7.9) already include [pip](https://pip.pypa.io).

If it missing you can easily [install](https://pip.pypa.io/en/stable/installing/#install-pip) it.

Once [pip](https://pip.pypa.io) is installed, you have to move to the directory  where you cloned this project

```bash

cd /dir/bedita/docs

```

install the project dependencies (which may require administrator access)

```bash

pip install -r requirements.txt

```

compile the documentation

```bash

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.