Skip to content

Commit 9996103

Browse files
authored
Merge pull request #112 from bfabio/pages
chore: publish on GitHub Pages
2 parents 2574afc + 4c98243 commit 9996103

5 files changed

Lines changed: 48 additions & 26 deletions

File tree

.github/workflows/publish.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: publish
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: actions/setup-python@v2
14+
with:
15+
python-version: '3.8'
16+
17+
- run: pip install -r requirements.txt
18+
- run: sphinx-build docs/en build -c .
19+
20+
- name: Publish on GitHub Pages
21+
uses: peaceiris/actions-gh-pages@v3
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}
24+
publish_dir: ./build

README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,9 @@
33
[![GitHub release](https://img.shields.io/github/release/italia/publiccode.yml.svg?style=plastic)](https://github.com/italia/publiccode.yml/releases)
44
[![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg)](https://developersitalia.slack.com/messages/CAM3F785T)
55
[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
6-
[![Docs
7-
Italia](https://docs.italia.it/media/static/projects/badges/passing.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
8-
[![Documentation](https://img.shields.io/badge/Documentation-Docs%20Italia-blue.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
96

107
> A metadata description standard for public software.
118
12-
* Read documentation in [English](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/)
13-
* Leggi la documentazione in [italiano](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/)
14-
159
---
1610

1711
## Table of Contents
@@ -58,15 +52,6 @@ The `publiccode.yml` file format should both be able to easily be added to any
5852
new project, as well as grow with the project as it expands beyond the original
5953
context it was developed in.
6054

61-
## Documentation
62-
63-
This repository is structured in order to be compatible with the [Docs Italia](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/)
64-
platform. As such, the content in the relevant folders will be
65-
compiled and rendered inside that platform. The `Docs Italia` platform is
66-
able to handle different releases and localised versions of the same file
67-
drawing from the document's GitHub repository. As such, the platform is to be
68-
considered the default landing page for the project.
69-
7055
## Finding projects
7156

7257
Finding projects depends on how the search API is structured for every hosting

conf.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Sphinx RTD theme demo documentation build configuration file, created by
4+
# sphinx-quickstart on Sun Nov 3 11:56:36 2013.
5+
#
6+
# This file is execfile()d with the current directory set to its containing dir.
7+
#
8+
# Note that not all possible configuration values are present in this
9+
# autogenerated file.
10+
#
11+
# All configuration values have a default; values that are commented out
12+
# serve to show the default.
13+
14+
project = "publiccode.yml Standard"
15+
16+
html_theme = "press"
17+
18+
extensions = [
19+
'sphinx.ext.autodoc',
20+
'sphinx.ext.viewcode',
21+
'sphinx.ext.doctest',
22+
]

document_settings.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Sphinx==4.3.1
2+
sphinx-press-theme==0.8.0

0 commit comments

Comments
 (0)