From 9405620b999cd5d4de197ad38dad6a645353493d Mon Sep 17 00:00:00 2001 From: Philip Allgaier Date: Fri, 23 Jun 2023 11:38:56 +0200 Subject: [PATCH] Remove Travis build status badge (#482) --- README.md | 16 +++++++++-- update_documentation.sh | 61 ----------------------------------------- 2 files changed, 14 insertions(+), 63 deletions(-) delete mode 100644 update_documentation.sh diff --git a/README.md b/README.md index 08b66c7..3c571e8 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,9 @@ [![image](https://img.shields.io/pypi/v/voluptuous.svg)](https://python.org/pypi/voluptuous) [![image](https://img.shields.io/pypi/l/voluptuous.svg)](https://python.org/pypi/voluptuous) [![image](https://img.shields.io/pypi/pyversions/voluptuous.svg)](https://python.org/pypi/voluptuous) -[![Build Status](https://travis-ci.org/alecthomas/voluptuous.svg)](https://travis-ci.org/alecthomas/voluptuous) -[![Coverage Status](https://coveralls.io/repos/github/alecthomas/voluptuous/badge.svg?branch=master)](https://coveralls.io/github/alecthomas/voluptuous?branch=master) [![Gitter chat](https://badges.gitter.im/alecthomas.svg)](https://gitter.im/alecthomas/Lobby) +[![Test status](https://github.com/alecthomas/voluptuous/actions/workflows/tests.yml/badge.svg)](https://github.com/alecthomas/voluptuous/actions/workflows/tests.yml) +[![Coverage status](https://coveralls.io/repos/github/alecthomas/voluptuous/badge.svg?branch=master)](https://coveralls.io/github/alecthomas/voluptuous?branch=master) +[![Gitter chat](https://badges.gitter.im/alecthomas.svg)](https://gitter.im/alecthomas/Lobby) Voluptuous, *despite* the name, is a Python data validation library. It is primarily intended for validating data coming into Python as JSON, @@ -40,6 +41,16 @@ To file a bug, create a [new issue](https://github.com/alecthomas/voluptuous/iss The documentation is provided [here](http://alecthomas.github.io/voluptuous/). +## Contribution to Documentation + +Documentation is built using `Sphinx`. You can install it by + + pip install -r requirements.txt + +For building `sphinx-apidoc` from scratch you need to set PYTHONPATH to `voluptuous/voluptuous` repository. + +The documentation is provided [here.](http://alecthomas.github.io/voluptuous/) + ## Changelog See [CHANGELOG.md](https://github.com/alecthomas/voluptuous/blob/master/CHANGELOG.md). @@ -706,3 +717,4 @@ using voluptuous validators in `assert`s. I greatly prefer the light-weight style promoted by these libraries to the complexity of libraries like FormEncode. + diff --git a/update_documentation.sh b/update_documentation.sh deleted file mode 100644 index 7651835..0000000 --- a/update_documentation.sh +++ /dev/null @@ -1,61 +0,0 @@ -#!/usr/bin/env bash - -# Merge pushes to development branch to stable branch -if [ ! -n $2 ] ; then - echo "Usage: merge.sh " - exit 1; -fi - -GIT_USER="$1" -GIT_PASS="$2" - -# Specify the development branch and stable branch names -FROM_BRANCH="master" -TO_BRANCH="gh-pages" - -# Needed for setting identity -git config --global user.email "tusharmakkar08@gmail.com" -git config --global user.name "Tushar Makkar" -git config --global push.default "simple" - -# Get the current branch -export PAGER=cat -CURRENT_BRANCH=$(git log -n 1 --pretty=%d HEAD | cut -d"," -f3 | cut -d" " -f2 | cut -d")" -f1) -echo "current branch is '$CURRENT_BRANCH'" - -# Create the URL to push merge to -URL=$(git remote -v | head -n1 | cut -f2 | cut -d" " -f1) -echo "Repo url is $URL" -PUSH_URL="https://$GIT_USER:$GIT_PASS@${URL:8}" - -git remote set-url origin ${PUSH_URL} - -echo "Checking out $FROM_BRANCH..." && \ -git fetch origin ${FROM_BRANCH}:${FROM_BRANCH} && \ -git checkout ${FROM_BRANCH} - - -echo "Checking out $TO_BRANCH..." && \ -# Checkout the latest stable -git fetch origin ${TO_BRANCH}:${TO_BRANCH} && \ -git checkout ${TO_BRANCH} && \ - -# Merge the dev into latest stable -echo "Merging changes..." && \ -git merge ${FROM_BRANCH} && \ - -# Push changes back to remote vcs -echo "Pushing changes..." && \ -git push origin gh-pages &> /dev/null && \ -echo "Merge complete!" || \ -echo "Error Occurred. Merge failed" - -export PYTHONPATH=${PYTHONPATH}:$(pwd):$(pwd)/voluptuous - -pip install -r requirements.txt && sphinx-apidoc -o docs -f voluptuous && -cd docs && make html || -echo "Sphinx not able to generate HTML" - -git status && git add . && -git commit -m "Auto updating documentation from $CURRENT_BRANCH" && -git push origin gh-pages &> /dev/null && echo "Documentation pushed"