From 41e0a13bc3f8e8b0c52a4038a426f43870c43553 Mon Sep 17 00:00:00 2001 From: Stefan Tatschner Date: Tue, 11 Oct 2022 11:31:00 +0200 Subject: [PATCH] chore: Add readthedocs --- .readthedocs.yaml | 13 +++++++++++++ .readthedocs.yaml.license | 3 +++ README.md | 3 +++ 3 files changed, 19 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 .readthedocs.yaml.license diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..53907816d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +# https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "3.10" + commands: + - curl -sSL https://install.python-poetry.org | python3 - + - $HOME/.local/bin/poetry install + - $HOME/.local/bin/poetry run make docs + - mkdir _readthedocs + - mv docs/_build/html _readthedocs diff --git a/.readthedocs.yaml.license b/.readthedocs.yaml.license new file mode 100644 index 000000000..75b05f631 --- /dev/null +++ b/.readthedocs.yaml.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: AISEC Pentesting Team + +SPDX-License-Identifier: CC0-1.0 diff --git a/README.md b/README.md index 1cefc7a98..730574d65 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ SPDX-License-Identifier: CC0-1.0 # Gallia [![docs](https://img.shields.io/badge/-docs-green)](https://fraunhofer-aisec.github.io/gallia) +[![docs](https://readthedocs.org/projects/docs/badge/?version=latest)](https://gallia.readthedocs.io/en/latest) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gallia)](https://pypi.python.org/pypi/gallia/) [![PyPI - License](https://img.shields.io/pypi/l/gallia)](https://www.apache.org/licenses/LICENSE-2.0.html) [![PyPI](https://img.shields.io/pypi/v/gallia)](https://pypi.python.org/pypi/gallia/) @@ -17,6 +18,8 @@ Currently, the main focus lies on the [UDS](https://www.iso.org/standard/72439.h Taking advantage of this modular design, the [logging and archiving](https://fraunhofer-aisec.github.io/gallia/penlog.7.html) functionality was developed separately. Acting as a generic interface, the logging functionality implements reproducible tests and enables post-processing tasks. The [rendered documentation](https://fraunhofer-aisec.github.io/gallia) is available via Github Pages. +Alternatively, the documentation is hosted on [readthedocs](https://gallia.readthedocs.io/en/latest) as well. +The documentation for the current [stable](https://gallia.readthedocs.io/en/stable) realease is available on readthedocs. Keep in mind that this project is intended for research and development usage only! Inappropriate usage might cause irreversible damage to the device under test.