docs: add a simple, auto-generated index.md

This is useful for the github pages feature
This commit is contained in:
Lennart Poettering 2018-10-02 09:53:05 +02:00 committed by Zbigniew Jędrzejewski-Szmek
parent b2d1fbda78
commit 0bc7a22d93
3 changed files with 44 additions and 0 deletions

25
docs/index.md Normal file
View File

@ -0,0 +1,25 @@
# systemd Documentation
* [The Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md)
* [Control Group APIs and Delegation](CGROUP_DELEGATION.md)
* [The systemd Community Conduct Guidelines](CODE_OF_CONDUCT.md)
* [Code Quality Tools](CODE_QUALITY.md)
* [Contributing](CONTRIBUTING.md)
* [Porting systemd To New Distributions](DISTRO_PORTING.md)
* [Known Environment Variables](ENVIRONMENT.md)
* [Portable Services Introduction](PORTABLE_SERVICES.md)
* [Steps to a successful release](RELEASE.md)
* [What settings are currently available for transient units?](TRANSIENT-SETTINGS.md)
* [Notes for Translators](TRANSLATORS.md)
* [Users, Groups, UIDs and GIDs on `systemd` systems](UIDS-GIDS.md)

View File

@ -2909,6 +2909,10 @@ run_target(
depends : [man, libsystemd, libudev],
command : [meson_check_api_docs_sh, libsystemd.full_path(), libudev.full_path()])
run_target(
'make-index-md',
command : ['sh', '@0@/tools/make-index-md.sh'.format(meson.source_root()), meson.source_root()])
############################################################
status = [

15
tools/make-index-md.sh Executable file
View File

@ -0,0 +1,15 @@
#!/bin/sh
set -eu
cd "$@"/docs/
(
echo "# systemd Documentation"
for f in *.md ; do
if [ "x$f" != "xindex.md" ] ; then
t=`grep "^# " "$f" | head -n 1 | sed -e 's/^#\s*//'`
echo -e "\n* [$t]($f)"
fi
done
) > index.md