Update Module Level Docstrings and Tests for User Entity #7
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Validate Sphinx Documentation Was Built And Included In The Commit Before Pushing | |
on: [push, pull_request] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.10' | |
- name: Install dependencies | |
run: | | |
pip install sphinx telethon sphinx-book-theme | |
- name: Build Sphinx documentation | |
run: | | |
cd docs | |
sphinx-apidoc -o source ../ | |
make html | |
- name: Check for uncommitted changes (if this step fails, it means that sphinx built new doc files) | |
run: | | |
git status | |
git diff | |
if [[ -n $(git status -s) ]]; then | |
echo "There are uncommitted changes after building the documentation." | |
exit 1 | |
fi |