Skip to content

Commit

Permalink
Move the jinja-docsite source files to the main branch (#182)
Browse files Browse the repository at this point in the history
* move jinja-docsite source to main

* update readme and contributing

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* readthedocs config

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

mkdir rtd html

avoid unnecessary subdir

* docsite ci

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

rm unused action

docsite ci

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

Update .github/workflows/ci.yaml

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* do not cp http redirects etc

* disable pip version check

* create workflow archive

* build.py

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* project requirements

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* add noxfile

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Update .readthedocs.yaml

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Update .github/workflows/reusable-build-docsite.yaml

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* upgrade staticjinja

---------

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
  • Loading branch information
oraNod and webknjaz authored Aug 23, 2023
1 parent 961e90e commit a6f7e4f
Show file tree
Hide file tree
Showing 78 changed files with 2,960 additions and 4,785 deletions.
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:
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
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

0 comments on commit a6f7e4f

Please sign in to comment.