chore: publish on GitHub Pages

publiccodeyml · Dec 9, 2021 · 4c98243 · 4c98243
1 parent 2574afc
commit 4c98243
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 26 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,24 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - run: pip install -r requirements.txt
+      - run: sphinx-build docs/en build -c .
+
+      - name: Publish on GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
diff --git a/README.md b/README.md
@@ -3,15 +3,9 @@
 [![GitHub release](https://img.shields.io/github/release/italia/publiccode.yml.svg?style=plastic)](https://github.com/italia/publiccode.yml/releases)
 [![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg)](https://developersitalia.slack.com/messages/CAM3F785T)
 [![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
-[![Docs
-Italia](https://docs.italia.it/media/static/projects/badges/passing.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
-[![Documentation](https://img.shields.io/badge/Documentation-Docs%20Italia-blue.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
 
 > A metadata description standard for public software.
 
-* Read documentation in [English](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/)
-* Leggi la documentazione in [italiano](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/)
-
 ---
 
 ## Table of Contents
@@ -58,15 +52,6 @@ The `publiccode.yml` file format should both be able to easily be added to any
 new project, as well as grow with the project as it expands beyond the original
 context it was developed in.
 
-## Documentation
-
-This repository is structured in order to be compatible with the [Docs Italia](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/)
-platform. As such, the content in the relevant folders will be
-compiled and rendered inside that platform. The `Docs Italia` platform is
-able to handle different releases and localised versions of the same file
-drawing from the document's GitHub repository. As such, the platform is to be
-considered the default landing page for the project.
-
 ## Finding projects
 
 Finding projects depends on how the search API is structured for every hosting

diff --git a/conf.py b/conf.py
@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# Sphinx RTD theme demo documentation build configuration file, created by
+# sphinx-quickstart on Sun Nov  3 11:56:36 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+project = "publiccode.yml Standard"
+
+html_theme = "press"
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.doctest',
+]
diff --git a/document_settings.yml b/document_settings.yml
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx==4.3.1
+sphinx-press-theme==0.8.0