docs

biopragmatics · Dec 15, 2023 · 7b06126 · 7b06126
1 parent 8d28fb1
commit 7b06126
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/book.toml b/book.toml
@@ -19,8 +19,7 @@ create-missing = false
 command = "mdbook-admonish"
 assets_version = "3.0.1" # do not edit: managed by `mdbook-admonish install`
 
-[preprocessor.pagetoc]
-
+[preprocessor.pagetoc] # Does not work for no reason, managed to make it work once though
 [output.html]
 git-repository-url = "https://github.com/biopragmatics/curies.rs"
 additional-css = [

diff --git a/lib/docs/introduction.md b/lib/docs/introduction.md
@@ -14,7 +14,7 @@ Whether you're a developer looking to work with CURIEs (e.g. expand or compress)
 
 - 🛠️ **Create** your custom converter
 - 📥 **Import** converters from JSON or JSON-LD context, with helper functions for popular converters, such as `get_obo_converter()`.
-- 🔗 **Expand**: CURIEs from their compressed form to a URI.
+- 🔗 **Expand** CURIEs from their compressed form to URIs.
 - 🗜️ **Compress** URIs to CURIEs.
 
 ### 📦️ Packaged for multiple interfaces

diff --git a/lib/docs/use_python.md b/lib/docs/use_python.md
@@ -4,8 +4,8 @@
 
 You can easily work with `curies` from Python.
 
-```admonish warn title="Work in progress"
-This package is a work in progress.
+```admonish warning title="Work in progress"
+This package is a work in progress. This documentation might not be always up-to-date.
 ```
 
 ## 📥️ Install

diff --git a/scripts/docs-install.sh b/scripts/docs-install.sh
@@ -7,4 +7,4 @@ rustup update
 cargo install mdbook mdbook-admonish mdbook-pagetoc
 
 mkdir -p theme
-wget -O theme/mdbook-admonish.css https://raw.githubusercontent.com/leptos-rs/leptos/a8e25af5233bb014d3cee85e4e9be8b3e4586de9/docs/book/mdbook-admonish.css
+wget -O theme/mdbook-admonish.css https://raw.githubusercontent.com/leptos-rs/leptos/a8e25af5233bb014d3cee85e4e9be8b3e4586de9/docs/book/mdbook-admonish.css