Skip to content

Commit

Permalink
Fix journey links
Browse files Browse the repository at this point in the history
  • Loading branch information
maybeetree committed Feb 10, 2025
1 parent 87f4eee commit 666c22e
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ cd raidoc
python -m pip install -e .
```

If you're on a non-glibc system (e.g. Alpine Linux),
you will also need to install gcc, g++ and some headers
so that pip can compile the dependencies of this project:

```sh
apk add gcc g++ python3-dev musl-dev linux-headers
```

You can then build the documentation like this.
The command MUST be run from the root of the repo.

Expand Down
4 changes: 2 additions & 2 deletions doc/pages/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ class MyCompo(rai.Compo):
# Create instance
mycompo = MyCompo()

# Export to `mycimpo.cif`
# Export to `mycompo.cif`
rai.export_cif(mycompo)
```

To use the `raimad` command, invoke it as
`raimad <module>:<compo>`,
`raimad export <module>:<compo>`,
as demonstrated in the screencast below:

![screencast demonstrating the raimad export command](../asciinema/raimad-cli-export.enhance.cast)
Expand Down
4 changes: 2 additions & 2 deletions doc/templ/root.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h1>RAIDOC</h1>
{% if link.prev %}
<div class="journey-prev">
Previous:<br>
<a href="{{link.prev.path_html}}">{{link.prev.title}}</a>
<a href="{{webroot}}/{{link.prev.path_html}}">{{link.prev.title}}</a>
</div>
{% endif %}

Expand All @@ -47,7 +47,7 @@ <h1>RAIDOC</h1>
{% if link.next %}
<div class="journey-next">
Next:<br>
<a href="{{link.next.path_html}}">{{link.next.title}}</a>
<a href="{{webroot}}{{link.next.path_html}}">{{link.next.title}}</a>
</div>
{% endif %}
</div>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "raidoc"
version = "1.2.0.5"
version = "1.2.0.6"
description = "Documentation for RAIMAD"
authors = [
{name = "maybetree", email = "[email protected]"}
Expand Down

0 comments on commit 666c22e

Please sign in to comment.