Skip to content

Commit

Permalink
Enable extra job for building docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea committed Aug 20, 2024
1 parent a95c42d commit 1e1e78a
Show file tree
Hide file tree
Showing 31 changed files with 7,441 additions and 3,087 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/tox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ jobs:
runs-on: ${{ matrix.os || 'ubuntu-24.04' }}
continue-on-error: ${{ contains(matrix.name, 'integration') && true || false }}
needs:
- docs
- prepare
defaults:
run:
Expand Down Expand Up @@ -153,6 +154,15 @@ jobs:
exit 99
fi
# https://github.com/actions/toolkit/issues/193
docs:
permissions:
contents: read
name: Validate Ansible Docs
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
with:
collection-name: ansible.eda
init-lenient: false
init-fail-on-error: true
check:
if: always()
environment: check
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ tests/integration/event_source_kafka/*.jks
# Coverage
.coverage*
*coverage.combined
# docs/requirements.txt
docs/build.sh
docs/antsibull-docs.cfg
docs/conf.py
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.12"
commands:
- pip install --user tox
- python3 -m tox -e docs
- ln -s docs/build/html . $READTHEDOCS_OUTPUT/html/
8 changes: 8 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

# Created with antsibull-docs 2.12.0

/temp-rst
/build
219 changes: 0 additions & 219 deletions docs/ansible.eda.activation_info_module.rst

This file was deleted.

Loading

0 comments on commit 1e1e78a

Please sign in to comment.