https://github.com/opendp/docs.smartnoise.org
A work in progress.
https://github.com/opendp/docs.smartnoise.org
differential-privacy documentation opendp privacy smartnoise
Last synced: 5 months ago
JSON representation
A work in progress.
- Host: GitHub
- URL: https://github.com/opendp/docs.smartnoise.org
- Owner: opendp
- License: mit
- Created: 2020-10-19T19:26:42.000Z (over 5 years ago)
- Default Branch: latest
- Last Pushed: 2022-01-06T17:52:48.000Z (over 4 years ago)
- Last Synced: 2023-03-05T09:57:17.589Z (over 3 years ago)
- Topics: differential-privacy, documentation, opendp, privacy, smartnoise
- Language: Python
- Homepage: http://docs.opendp.org
- Size: 3.71 MB
- Stars: 4
- Watchers: 10
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## DEPRECATED!
- Note: [docs.smartnoise.org](https://docs.smartnoise.org/) is now built directly from the [SmartNoise SDK repository](https://github.com/opendp/smartnoise-sdk)
---
[](https://opensource.org/licenses/MIT)
# docs.smartnoise.org
## Building the Docs
The steps below assume the use of [Homebrew] on a Mac.
[Homebrew]: https://brew.sh
Note that Python 3.8 is required. Python 3.9 is known not to work with the synthesizers packages.
```
/usr/local/opt/python\@3.8/bin/python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
make html
open build/html/index.html
```
## Deployment
Docs are deployed to http://docs.smartnoise.org using GitHub Actions.
Note that `make html` is replaced with `make versions` to build multiple versions (branches, tags) using the [sphinx-multiversion][] extension.
[sphinx-multiversion]: https://holzhaus.github.io/sphinx-multiversion/
## Join the Discussion
You are very welcome to join us on [GitHub Discussions][]!
[GitHub Discussions]: https://github.com/opendp/opendp/discussions/categories/smartnoise