From 02d8428b4df2297f4f7da7702e4d996fae13e9c1 Mon Sep 17 00:00:00 2001
From: Markus Scheidgen <markus.scheidgen@gmail.com>
Date: Wed, 23 Feb 2022 11:28:52 +0100
Subject: [PATCH] Added mathjax to mkdocs. Minor documentation changes.
---
docs/archive_query.md | 8 ++++----
mkdocs.yml | 7 ++++++-
2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/docs/archive_query.md b/docs/archive_query.md
index 8df1fe1546..d0b61c29d3 100644
--- a/docs/archive_query.md
+++ b/docs/archive_query.md
@@ -26,8 +26,8 @@ The fetch process is carried out **synchronously**. Users can call
number_of_entries = query.fetch()
```
-to perform the fetch process to fetch up to `results_max` entries. An indicative number $$n$$ can be provided `fetch(n)`
-. Given that each upload may contain various numbers of entries, the fetch process guarantees at least $$n$$ entries
+to perform the fetch process to fetch up to `results_max` entries. An indicative number `n` can be provided `fetch(n)`
+. Given that each upload may contain various numbers of entries, the fetch process guarantees at least `n` entries
will be fetched. The exact number is determined by `page_size`, indicating how many uploads in each page. However, this
would be limited to the `results_max`. The exact qualified number of entries will be returned. Meanwhile, the qualified
upload list would be populated with their IDs. To check all qualified upload IDs, one can call `upload_list()` method to
@@ -152,7 +152,7 @@ result = query.download(100)
print(f'Downloaded {len(result)} entries.') # Downloaded 102 entries.
```
-In the above, we request additional 100 entries, however, the list contains only $$6+82+10=98$$ entries, fetch process
+In the above, we request additional 100 entries, however, the list contains only `6+82+10=98` entries, fetch process
will be called to fetch new entries from server. You will see the following message in terminal.
```text
@@ -165,7 +165,7 @@ Downloaded 102 entries.
## Argument List
-The following arguments are acceptable.
+The following arguments are acceptable for `ArchiveQuery`.
- `owner` : `str` The scope of data to access. Default: `'visible'`
- `query` : `dict` The API query. There are no validations of any means carried out by the class, users shall make sure
diff --git a/mkdocs.yml b/mkdocs.yml
index 1b9485b407..f8385918de 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -44,6 +44,8 @@ markdown_extensions:
- toc:
permalink: True
toc_depth: 3
+ - pymdownx.arithmatex:
+ generic: true
extra:
generator: false
homepage: https://nomad-lab.eu/prod/v1/gui/about
@@ -55,4 +57,7 @@ plugins:
extra_css:
- stylesheets/extra.css
extra_javascript:
- - javascript.js
\ No newline at end of file
+ - javascript.js
+ - javascripts/mathjax.js
+ - https://polyfill.io/v3/polyfill.min.js?features=es6
+ - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
\ No newline at end of file
--
GitLab