Skip to content

Commit 5872490

Browse files
committed
prepare for tutorial section
1 parent b9d8665 commit 5872490

8 files changed

Lines changed: 51 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
<img alt="Pasteur Logo with text. Tagline reads: 'Sanitize Your Data'" src="https://raw.githubusercontent.com/pasteur-dev/pasteur/master/res/logo/text_light.svg" width="90%">
66
</picture>
77
</h1>
8+
9+
[![PyPI package version](https://badge.fury.io/py/pasteur.svg)](https://pypi.org/project/pasteur/)
10+
[![Docs build status](https://readthedocs.org/projects/pasteur/badge/?version=latest)](https://docs.pasteur.dev/)
11+
[![License is Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-informational.svg)](https://opensource.org/license/apache2-0-php/)
12+
[![Python version 3.10+](https://img.shields.io/badge/python-3.10%2B-informational.svg)](https://pypi.org/project/pasteur/)
13+
[![Code style is Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/psf/black)
14+
<!-- [![]()]() -->
15+
816
Pasteur is a library for performing privacy-aware end-to-end data synthesis.
917
Gather your raw data and preprocess, synthesize, and evaluate it within a single
1018
project.

docs/source/index.rst

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,36 @@
44
55
Welcome to Pasteur's documentation!
66
=============================================
7+
.. image:: https://badge.fury.io/py/pasteur.svg
8+
:target: https://pypi.org/project/pasteur/
9+
:alt: PyPI package version
10+
11+
.. image:: https://readthedocs.org/projects/pasteur/badge/?version=latest
12+
:target: https://docs.pasteur.dev/
13+
:alt: Docs build status
14+
15+
.. image:: https://img.shields.io/badge/license-Apache%202.0-informational.svg
16+
:target: https://opensource.org/license/apache2-0-php/
17+
:alt: License is Apache 2.0
18+
19+
.. image:: https://img.shields.io/badge/python-3.10%2B-informational.svg
20+
:target: https://pypi.org/project/pasteur/
21+
:alt: Python version 3.10+
22+
23+
.. image:: https://img.shields.io/badge/code%20style-black-black.svg
24+
:target: https://github.com/psf/black
25+
:alt: Code style is Black
26+
27+
----------------------
28+
29+
This documentation is a work-in-progress!
730

831
.. toctree::
932
:maxdepth: 2
10-
:caption: Introduction
33+
:caption: Tutorial
34+
:glob:
1135

12-
intro/preliminaries
36+
tutorial/*
1337

1438
.. toctree::
1539
:maxdepth: 2
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"cell_type": "markdown",
66
"metadata": {},
77
"source": [
8-
"# Preliminaries "
8+
"# Preliminaries\n",
9+
"![Methodology overview](res/graphs-pipeline_simple.svg)"
910
]
1011
},
1112
{

docs/source/tutorial/res/graphs-complete_pipeline.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/source/tutorial/res/graphs-encoding.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/source/tutorial/res/graphs-parallel.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/source/tutorial/res/graphs-partitioning.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/source/tutorial/res/graphs-pipeline_simple.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)