Skip to content

Commit 110e040

Browse files
authored
New docs (#236)
* new docs * new docs * new docs * new docs * new docs * new docs * new docs * new docs * new docs * remove old site * remove old site * remove old site * remove old site * rearrange docs * fix * fix website attempt * fix website attempt * fix website attempt * fix notebook dir * remove top level mkdocs.yml * remove top level mkdocs.yml * maintainers
1 parent 86ad8da commit 110e040

File tree

99 files changed

+219
-875
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+219
-875
lines changed

.github/workflows/ci.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- newdocs
6+
- master
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- run: pip install mkdocs-material
18+
# - run: mkdocs gh-deploy --force

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
src/data
2+
docs/site
23
venv
34
_cache
45
docs/build

.netlify/state.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

MAINTAINERS.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,4 @@ A **new major GHC version** has been released. Here's what you need to do:
5151

5252
## Documentation
5353

54-
The docs are built with Sphinx. Once installed, cd to the `docs` directory, then run `make html` to build locally. CI does this automatically, so to update the docs, just update the markdown (e.g. docs/source/usage.md), and push.
55-
56-
## Website
57-
58-
The website is also hosted in the repo (`/monad-bayes-site`), and is built with `hakyll`. Do `stack exec site build` to build. CI **does not** automatically build the site, so to update, you will need to run this command, and only then push to github.
54+
The docs are built with MkDocs. Serve locally with: `mkdocs serve`. Site is served online with Netlify.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Monad-Bayes](https://monad-bayes-site.netlify.app/_site/about.html)
1+
# [Monad-Bayes](https://monad-bayes.netlify.app/)
22

33
A library for probabilistic programming in Haskell.
44

@@ -7,7 +7,7 @@ A library for probabilistic programming in Haskell.
77
[![Hackage Deps](https://img.shields.io/hackage-deps/v/monad-bayes.svg)](http://packdeps.haskellers.com/reverse/monad-bayes)
88
[![Build status](https://badge.buildkite.com/147af088063e8619fcf52ecf93fa7dd3353a2e8a252ef8e6ad.svg?branch=master)](https://buildkite.com/tweag-1/monad-bayes) -->
99

10-
[See the website](https://monad-bayes-site.netlify.app/_site/about.html) for an overview of the documentation, library, tutorials, examples (and a link to this very source code).
10+
[See the docs](https://monad-bayes.netlify.app/) for a user guide, notebook-style tutorials, an example gallery, and a detailed account of the implementation.
1111

1212
<!-- Monad-Bayes is a library for **probabilistic programming in Haskell**. The emphasis is on composition of inference algorithms, and is implemented in terms of monad transformers. -->
1313

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/docs/examples.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Example Gallery
3+
---
4+
5+
## [Histograms](/notebooks/Histogram.html)
6+
7+
## [JSON (with `lens`)](/notebooks/Lenses.html)
8+
9+
## [Diagrams](/notebooks/Diagrams.html)
10+
11+
## [Probabilistic Parsing](/notebooks/Parsing.html)
12+
13+
## [Streams (with `pipes`)](/notebooks/Streaming.html)
14+
15+
## [Ising models](/notebooks/Ising.html)
16+
17+
## [Physics](/notebooks/ClassicalPhysics.html)
18+
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)