This is Kinovea's user-documentation project.
This project is to create the user manual. Please post issues about the program in the main repository and use this one for issues about the documentation itself.
Main website: https://www.kinovea.org/
The current live documentation can be found here: https://www.kinovea.org/help/index.htm
The manual in this repository is automatically rebuilt at readthedocs here: https://kinovea.readthedocs.io/en/latest/
List of successive release posts since version 0.8.15, containing descriptions of new features (some of the features have seen multiple updates over the course of these versions):
| Link | Release date |
|---|---|
| 2024.1 | 2024-08 |
| 2023.1 | 2023-08 |
| 0.9.5 | 2021-10 |
| 0.9.4 | 2021-04 |
| 0.9.2 / 0.9.3 | 2020-07 |
| 0.9.1 | 2019-12 |
| 0.8.27 | 2018-10 |
| 0.8.26 | 2017-11 |
| 0.8.25 | 2016-08 |
| 0.8.24 | 2015-03 |
| 0.8.23 | 2014-10 |
| 0.8.22 | 2014-06 |
| 0.8.21 | 2013-10 |
| 0.8.20 | 2013-01 |
| 0.8.19 | 2012-09 |
| 0.8.18 | 2012-08 |
| 0.8.17 | 2012-03 |
| 0.8.16 | 2011-08 |
| 0.8.15 | 2011-05 |
You do not need to do this to contribute to the documentation. You can also fork the repository, make some changes and create a pull request.
The documentation uses Sphinx. Sphinx is essentially a static website generator that takes a collection of reStructuredText text files and compiles them into static HTML pages. This website is then manually copied to the server under https://www.kinovea.org/help/en/
Installation
- Create a python venv on python 3.11
> pip install -U sphinx> pip install sphinx-rtd-theme
Build
- from kinovea-docs root:
> sphinx-build -M html source output- site is built in output.
Live testing (auto-build on changes)
> pip install sphinx-autobuild> sphinx-autobuild -M html source output- http://127.0.0.1:8000/