Skip to content

Commit f6c99b5

Browse files
committed
feat: Add new product details page
1 parent 90b2cb4 commit f6c99b5

16 files changed

+234
-237
lines changed

.github/workflows/publish.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Build and Upload to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Update this to match your main branch
7+
8+
jobs:
9+
build-and-upload:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
15+
- name: Install Dependencies
16+
run: |
17+
pip install -r requirements.txt
18+
19+
- name: Build Docs
20+
run: |
21+
./build.sh
22+
23+
- name: Upload Pages Artifact
24+
uses: actions/upload-pages-artifact@v1
25+
with:
26+
path: ./build/html # Update this to match your build directory

.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Copyright (c) Ansible Project
2+
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
3+
# SPDX-License-Identifier: GPL-3.0-or-later
4+
5+
# Created with antsibull-docs 2.5.0.post0
6+
7+
/temp-rst
8+
/build
9+
/rst/collections
10+
.dde

_css/css.scss

-117
This file was deleted.

antsibull-docs.cfg

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Copyright (c) Ansible Project
2+
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
3+
# SPDX-License-Identifier: GPL-3.0-or-later
4+
5+
# Created with antsibull-docs 2.5.0.post0
6+
7+
breadcrumbs = true
8+
indexes = true
9+
use_html_blobs = false
10+
11+
# You can specify ways to convert a collection name (<namespace>.<name>) to an URL here.
12+
# You can replace either of <namespace> or <name> by "*" to match all values in that place,
13+
# or use "*" for the collection name to match all collections. In the URL, you can use
14+
# {namespace} and {name} for the two components of the collection name. If you want to use
15+
# "{" or "}" in the URL, write "{{" or "}}" instead. Basically these are Python format
16+
# strings (https://docs.python.org/3.8/library/string.html#formatstrings).
17+
collection_url = {
18+
* = "https://galaxy.ansible.com/ui/repo/published/{namespace}/{name}/"
19+
}
20+
21+
# The same wildcard rules and formatting rules as for collection_url apply.
22+
collection_install = {
23+
* = "ansible-galaxy collection install {namespace}.{name}"
24+
}

build.sh

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/usr/bin/env bash
2+
# Copyright (c) Ansible Project
3+
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
4+
# SPDX-License-Identifier: GPL-3.0-or-later
5+
6+
# Created with antsibull-docs 2.5.0.post0
7+
8+
set -e
9+
10+
pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
11+
trap "{ popd; }" EXIT
12+
13+
# Create collection documentation into temporary directory
14+
rm -rf temp-rst
15+
mkdir -p temp-rst
16+
chmod og-w temp-rst # antsibull-docs wants that directory only readable by itself
17+
antsibull-docs \
18+
--config-file antsibull-docs.cfg \
19+
collection \
20+
--dest-dir temp-rst \
21+
arillso.system arillso.agents
22+
23+
# Copy collection documentation into source directory
24+
rsync -cprv --delete-after temp-rst/collections/ rst/collections/
25+
26+
# Build Sphinx site
27+
sphinx-build -M html rst build -c . -W --keep-going

conf.py

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Copyright (c) Ansible Project
2+
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
3+
# SPDX-License-Identifier: GPL-3.0-or-later
4+
5+
# Created with antsibull-docs 2.5.0.post0
6+
7+
# This file only contains a selection of the most common options. For a full list see the
8+
# documentation:
9+
# http://www.sphinx-doc.org/en/master/config
10+
11+
project = 'Arillso Guide'
12+
copyright = 'Arillso contributors'
13+
14+
title = 'Arillso Guide Documentation'
15+
html_short_title = 'Arillso Guide Documentation'
16+
17+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx_antsibull_ext']
18+
19+
pygments_style = 'ansible'
20+
21+
highlight_language = 'YAML+Jinja'
22+
23+
html_theme = 'sphinx_ansible_theme'
24+
html_show_sphinx = False
25+
26+
display_version = False
27+
28+
html_use_smartypants = True
29+
html_use_modindex = False
30+
html_use_index = False
31+
html_copy_source = False
32+
33+
# See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping for the syntax
34+
intersphinx_mapping = {
35+
'python': ('https://docs.python.org/2/', (None, '../python2.inv')),
36+
'python3': ('https://docs.python.org/3/', (None, '../python3.inv')),
37+
'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')),
38+
'ansible_devel': ('https://docs.ansible.com/ansible/devel/', (None, '../ansible_devel.inv')),
39+
# If you want references to resolve to a released Ansible version (say, `5`), uncomment and replace X by this version:
40+
# 'ansibleX': ('https://docs.ansible.com/ansible/X/', (None, '../ansibleX.inv')),
41+
}
42+
43+
default_role = 'any'
44+
45+
nitpicky = True
46+
47+
html_theme_options = {
48+
# 'canonical_url': "https://docs.ansible.com/ansible/latest/",
49+
'topbar_links': {
50+
'Home': 'https://arillso.io',
51+
},
52+
# URL to send the user to when clicking on the title link
53+
'documentation_home_url': '/',
54+
}

docs/_sidebar.md

-33
This file was deleted.

docs/index.md

-14
This file was deleted.

docs/skeleton.md

-5
This file was deleted.

docs/variables.md

-22
This file was deleted.

index.html

-46
This file was deleted.

requirements.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Copyright (c) Ansible Project
2+
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
3+
# SPDX-License-Identifier: GPL-3.0-or-later
4+
5+
# Created with antsibull-docs 2.5.0.post0
6+
7+
antsibull-docs >= 2.0.0, < 3.0.0
8+
ansible-pygments
9+
sphinx
10+
sphinx-ansible-theme >= 0.9.0

0 commit comments

Comments
 (0)