~cypheon/idris2-quickdocs

bafccda6bb8dd4749620dbe6726c908d88989640 — Johann Rudloff a month ago a6d17f6 main
Update docs & scripts to account for recent Idris2 upstream
3 files changed, 5 insertions(+), 9 deletions(-)

M README.md
M rebuild_all.sh
M templates/home.md.j2
M README.md => README.md +1 -3
@@ 10,9 10,7 @@ A demo of this is hosted at [https://idris2docs.sinyax.net](https://idris2docs.s
## Requirements

To generate the documentation index, you need Python 3,
[poetry](https://python-poetry.org/) and the [`mkdoc` branch of my Idris2
fork](https://github.com/cypheon/Idris2/tree/mkdoc) (at least until the doc
generation is ready to be upstreamed).
[poetry](https://python-poetry.org/) and a recent (>= 0.5.1) version of Idris 2.

## Usage


M rebuild_all.sh => rebuild_all.sh +2 -4
@@ 5,8 5,8 @@ set -u
set -o pipefail
set -x

src_root=${IDRIS2_SRC:-$PWD/../mkdocs}
idris2=${IDRIS2_EXECUTABLE:-$src_root/build/exec/idris2}
src_root=${IDRIS2_SRC:-$PWD/../Idris2-SH}
idris2=${IDRIS2_EXECUTABLE:-idris2}

build_doc() {
  pkg="$1"


@@ 29,5 29,3 @@ done

poetry run ./mkindex.py data
poetry run ./mkhome.py data

chmod -R ugo+rX data

M templates/home.md.j2 => templates/home.md.j2 +2 -2
@@ 23,9 23,9 @@ Each `tar.gz` contains self-contained HTML for offline viewing (but without

### Source Code

#### Idris2 branch with `--mkdoc` support
#### Idris2 with `--mkdoc` support
available at:
<a href="https://github.com/cypheon/Idris2/tree/mkdoc" target="_blank">https://github.com/cypheon/Idris2/tree/mkdoc</a>
<a href="https://github.com/idris-lang/Idris2" target="_blank">https://github.com/idris-lang/Idris2</a>

#### Index Builder and Search JavaScript
available at: