Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the jinja-docsite source files to the main branch #182

Merged
merged 13 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Ansible docsite CI

on:
pull_request:
push:
oraNod marked this conversation as resolved.
Show resolved Hide resolved
branches:
- "main"
workflow_dispatch:

jobs:
build-docsite:
uses: ./.github/workflows/reusable-build-docsite.yaml
97 changes: 0 additions & 97 deletions .github/workflows/publish-package-docs.yaml

This file was deleted.

31 changes: 31 additions & 0 deletions .github/workflows/reusable-build-docsite.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Build the Ansible docsite

on:
workflow_call:

env:
PIP_DISABLE_PIP_VERSION_CHECK: 1

jobs:
build-docsite:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.11"
- name: Pip install nox
run: python -Im pip install nox
- name: Generate assets for the docs landing page
env:
PYTHONWARNINGS: >- # pip vendors deprecated `setuptools`' `pkg_resources`
error,once:pkg_resources is deprecated as an API.:DeprecationWarning:pip._internal.metadata.importlib._envs
run: python -Im nox -s build
- name: Create a downloadable archive of docs build
uses: actions/upload-artifact@v3
with:
name: docsite-html-assets
path: output/**
retention-days: 7
138 changes: 135 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,137 @@
.DS_Store
.cache/
.vscode/
site/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
site/

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# VScode stuff
.vscode/

# Generated HTML
output/
18 changes: 18 additions & 0 deletions .readthedocs.yaml
oraNod marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: >-
3.11
commands:
- python -m venv "${READTHEDOCS_VIRTUALENV_PATH}"
- >-
"${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -m
pip install nox
- >-
"${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
nox -s build -- "${READTHEDOCS_OUTPUT}"/html
Loading