diff --git a/docs/archive_query.md b/docs/archive_query.md index 8df1fe154648a9ca5c566888aa058e1012f4fb5a..d0b61c29d394f732128593932d7acf9cbea432e6 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 1b9485b40761735c43087db67fb10fbe237d859c..f8385918debfc53c5c678cab502565de6a9e5817 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