Re: Script to build the media documentation as if it were a single book

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 14/04/2020 15:37, Mauro Carvalho Chehab wrote:
> Hi,
> 
> In order for the media documentation to match the upstream rules, it was
> split for 5.7 into 3 different books. This makes total sense for upstream.
> 
> Yet, people may still want to see it as a single book. So, I wrote a small
> script (see enclosed) that does that.
> 
> I'm using a variant of it to produce the documentation output available at:
> 	https://linuxtv.org/docs.php
> 
> (with is updated once per day).
> 
> Perhaps others could find this script useful. This script is under GPLv2,
> but please notice that some media docs are under GFDL licensing.
> 
> Thanks,
> Mauro
> 
> 
> #!/bin/bash
> 
> git remote update
> git reset --hard remotes/origin/$BRANCH
> 
> sed s,userspace-api/media,media/userspace-api, -i Documentation/Makefile
> 
> mkdir -p Documentation/media
> 
> cat <<END >Documentation/media/index.rst
> .. SPDX-License-Identifier: GPL-2.0
> 
> .. include:: <isonum.txt>
> 
> **Copyright** |copy| 1991-: LinuxTV Developers
> 
> ================================
> Linux Kernel Media Documentation
> ================================
> 
> .. toctree::
> 	:maxdepth: 4
> 
>         admin-guide/index
>         driver-api/index
>         userspace-api/index

Wouldn't it make more sense to have the userspace-api before the admin-guide?

Regards,

	Hans

> END
> 
> rsync -vuza --delete Documentation/admin-guide/media/ Documentation/media/admin-guide
> rsync -vuza --delete Documentation/driver-api/media/ Documentation/media/driver-api
> rsync -vuza --delete Documentation/userspace-api/media/ Documentation/media/userspace-api
> 
> make SPHINXDIRS="media" htmldocs
> make SPHINXDIRS="media" pdfdocs
> make SPHINXDIRS="media" epubdocs
> 




[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]

  Powered by Linux