Skip to content

Commit fd4410c

Browse files
committed
add mkdocs documentation
1 parent b767cf2 commit fd4410c

24 files changed

Lines changed: 5405 additions & 1540 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,6 @@ docs/_build
5353
normalized
5454

5555
.vscode
56+
57+
# mkdocs
58+
site/

DEVELOPERS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,9 @@ Tests are located in `test/test.py`. To run them:
66

77
- Install `requirements.txt` and `requirements.dev.txt`
88
- Run `pytest test/test.py`
9+
10+
## Creating API Docs
11+
12+
```bash
13+
pdoc -d google -o docs-api ./ffmpeg_normalize
14+
```

README.md

Lines changed: 13 additions & 574 deletions
Large diffs are not rendered by default.
Lines changed: 1073 additions & 920 deletions
Large diffs are not rendered by default.
File renamed without changes.

docs-api/search.js

Lines changed: 46 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
slhck.info

docs/about/contributing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
To contribute to this project, please follow these steps:
4+
5+
1. Fork the repository.
6+
2. Create a new branch.
7+
3. Make your changes and commit them.
8+
4. Push your changes to your fork.
9+
5. Create a pull request.

docs/about/license.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# License
2+
3+
The MIT License (MIT)
4+
5+
Copyright (c) Werner Robitza
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a
8+
copy of this software and associated documentation files (the
9+
"Software"), to deal in the Software without restriction, including
10+
without limitation the rights to use, copy, modify, merge, publish,
11+
distribute, sublicense, and/or sell copies of the Software, and to
12+
permit persons to whom the Software is furnished to do so, subject to
13+
the following conditions:
14+
15+
The above copyright notice and this permission notice shall be included
16+
in all copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/advanced/api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API
2+
3+
This program has a simple API that can be used to integrate it into other Python programs.
4+
5+
The API docs are [available here](https://htmlpreview.github.io/?https://github.com/slhck/ffmpeg-normalize/blob/master/docs-api/ffmpeg_normalize.html).

0 commit comments

Comments
 (0)