updated doc rendering & changelog

GNS-Science · May 26, 2022 · 9a249e2 · 9a249e2
1 parent ada724f
commit 9a249e2
Show file tree

Hide file tree

Showing 5 changed files with 120 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.1.3] - 2022-05-26
+### Changed
+ - fixed mkdoc rendering of python & markdown.
+
+
 ## [0.1.2] - 2022-05-26
 ### Changed
  - fix poetry lockfile

diff --git a/docs/api.md b/docs/api.md
@@ -1 +1 @@
-```::: toshi_hazard_store```
+::: toshi_hazard_store
diff --git a/docs/usage.md b/docs/usage.md
@@ -2,11 +2,11 @@
 
 To use toshi-hazard-store in a project
 
-```
 
+```
 from toshi_hazard_store import model, query
 
-TOSHI_ID = "FASDASDSAD" # A real Toshi ID is necesaary of course
+TOSHI_ID = "FASDASDSAD" # A real Toshi ID is necesaary of course.
 
 
 res = query.get_hazard_curves_stats(TOSHI_ID, 250, 'PGA', ['WLG', 'QZN', 'CHC', 'DUD'], ['mean'])
@@ -16,5 +16,5 @@ for r in res:
 res = query.get_hazard_curves_stats(TOSHI_ID, 250, 'SA(0.5)', None, ['mean'])
 for r in res:
     print(r)
-
 ```
+
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,9 +43,14 @@ pip  = { version = "^20.3.1", optional = true}
 mkdocs  = { version = "^1.1.2"}
 mkdocs-include-markdown-plugin  = { version = "^1.0.0"}
 mkdocs-material  = { version = "^6.1.7"}
-mkdocstrings  = { version = "^0.15.2"}
+mkdocstrings  = { version = "^0.18.0"}
 mkdocs-material-extensions  = { version = "^1.0.1"}
-mkdocs-autorefs = {version = "^0.2.1"}
+mkdocs-autorefs = {version = "^0.3.1"}
+
+pymdown-extensions = {version = "^9.4"}
+mkdocstrings-python = {version = "^0.6.5"}
+mkdocs-pymdownx-material-extras = "^2.0.3"
+
 twine  = { version = "^3.3.0"}
 
 pre-commit = {version = "^2.12.0", optional = true}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		```::: toshi_hazard_store```
		::: toshi_hazard_store