File: Readme.md

package info (click to toggle)
python-pweave 0.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 5,064 kB
  • sloc: python: 30,281; makefile: 167
file content (25 lines) | stat: -rw-r--r-- 733 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Pweave documentation

This directory contains Pweave documentation sources. You can find the latest published docs from http://mpastell.com/pweave.

## Contributing to the docs

Contributions to the docs are very welcome in order to keep them up to date!
The docs are generated from files in the `source` and `examples` directories.
If there is a matching `.rstw` and `.rst` file in the `source` directory
remember to edit `.rstw` version.

Build the docs using:

```bash
make html
```

Building the docs requires Pweave, Sphinx, LaTex and Pandoc.

You can install the required packages on Ubuntu using:

```bash
pip install sphinx sphinx_rtd_theme
sudo apt-get install texlive texlive-latex-extra texlive-generic-extra pandoc
```