Browse Source

Generate documentation homepage from README

merge-requests/22/head
Timothée Floure 1 year ago
parent
commit
ec0dc30c87
No known key found for this signature in database
GPG Key ID: 4502C902C00A1E12
  1. 2
      .gitlab-ci.yml
  2. 3
      README.md
  3. 19
      docs/src/index.rst.sh
  4. 2
      scripts/ci-container/Dockerfile

2
.gitlab-ci.yml

@ -25,5 +25,5 @@ docs:
- echo "$CD_SSH_SERVER_HOSTKEYS" > ~/.ssh/known_hosts
- chmod 644 ~/.ssh/known_hosts
script:
- make docs
- make html
- sftp fnux@staticwebhosting.ungleich.ch:public_html/cdist-contrib <<< "put -r docs/dist/html/*"

3
README.md

@ -6,7 +6,8 @@ maintained in cdist itself or were not accepted in code cdist but could still
be useful.
This project does not have releases and is continously updated: see git history
for change log.
for change log. You will find HTML documentation at
[contrib.cdi.st](https://contrib.cdi.st).
## Using cdist-contrib

19
docs/src/index.rst.sh

@ -9,23 +9,18 @@ __cdist_abs_myname="$__cdist_abs_mydir/$__cdist_myname"
filename="${__cdist_myname%.sh}"
dest="$__cdist_abs_mydir/$filename"
if ! command -v pandoc > /dev/null; then
echo "Pandoc is required to generate HTML index from README." >&2
exit 1
fi
cd "$__cdist_abs_mydir"
exec > "$dest"
cat << EOF
cdist-contrib - Community maintained cdist types
================================================
This project extends the \`cdist <https://cdi.st/>\`_ configuration management
tool with community-maitained types which are either too specific to fit/be
maintained in cdist itself or were not accepted in code cdist but could still
be useful.
Please note this project is a **rolling release**! The documentation you're
reading has been generated from the |version| state (commit |release|).
Sources are available on \`code.ungleich.ch
<https://code.ungleich.ch/ungleich-public/cdist-contrib>\`_.
pandoc -f markdown -t rst ../../README.md
cat << EOF
.. toctree::
:hidden:

2
scripts/ci-container/Dockerfile

@ -4,4 +4,4 @@ FROM fedora:latest
MAINTAINER Timothée Floure <fnux@ungleich.ch>
RUN dnf install -y git findutils make python3-sphinx python3-sphinx_rtd_theme \
ShellCheck openssh-clients
ShellCheck openssh-clients pandoc

Loading…
Cancel
Save