Skip to content

Commit

Permalink
chore: Add readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
rumpelsepp committed Oct 11, 2022
1 parent 370b70e commit 41e0a13
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .readthedocs.yaml.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: AISEC Pentesting Team

SPDX-License-Identifier: CC0-1.0
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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.
Expand Down

0 comments on commit 41e0a13

Please sign in to comment.