-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
234 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -155,3 +155,5 @@ dhlab/_version.py | |
# vscode settings | ||
.vscode | ||
poetry.lock | ||
docs/new_conf.py | ||
docs/orig_conf.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# ::: dhlab.api | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.api.dhlab_api | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.api.nb_ngram_api | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.api.nb_search_api | ||
options: | ||
show_root_heading: true | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# ::: dhlab.images | ||
options: | ||
show_root_heading: true | ||
|
||
|
||
## ::: dhlab.images.nbpictures | ||
options: | ||
show_root_heading: true | ||
|
||
|
||
## ::: dhlab.nbpictures | ||
options: | ||
show_root_heading: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
[![DH-LAB logo](_images/DHlab_logo_web_en_black.png)](https://www.nb.no/dh-lab/) | ||
|
||
# Welcome to the dhlab reference documentation | ||
|
||
This site documents the [code reference](./reference.md) for the [dhlab python library](https://pypi.org/project/dhlab/) functionalities. | ||
It is built directly from docstrings in our code library, and so the functionality documented here will reflect the [code base on GitHub](https://github.com/NationalLibraryOfNorway/DHLAB). | ||
|
||
Head to our [official homepage](https://www.nb.no/dh-lab/) for tutorials, how-to-guides, interactive web apps, and more information about the DH-lab group. | ||
|
||
## Project overview | ||
|
||
::: dhlab | ||
|
||
## Installation | ||
|
||
Ensure that you already have [Python >= 3.9](https://www.python.org/downloads/) installed. | ||
|
||
<!-- start installation --> | ||
|
||
Install the latest version of the [`dhlab`](https://pypi.org/project/dhlab/) python package in your (Unix) terminal with pip: | ||
|
||
```shell | ||
pip install -U dhlab | ||
``` | ||
<!-- end installation --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# ::: dhlab.metadata | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.metadata.natbib | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.metadata.metadata | ||
options: | ||
show_root_heading: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# :::dhlab.ngram | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.ngram.ngram | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.ngram.nb_ngram | ||
options: | ||
show_root_heading: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
This pages gives an overview of objects available at the top level of the package, | ||
that can be imported directly from `dhlab.*`, for example: `from dhlab import Corpus` | ||
|
||
|
||
### Classes and functions | ||
|
||
!!! info inline end | ||
|
||
We recommend importing these objects directly from dhlab, e.g.: | ||
|
||
from dhlab import Corpus | ||
|
||
The internal subpackages and module structure may change. | ||
If you access the top level objects via full module paths, | ||
you may need to refactor your imports with future releases of `dhlab`. | ||
|
||
- [`Corpus`][dhlab.text.corpus.Corpus] | ||
- [`Ngram`][dhlab.ngram.ngram.Ngram] | ||
- [`Chunks`][dhlab.text.chunking.Chunks] | ||
- [`Collocations`][dhlab.text.collocations.Collocations] | ||
- [`Concordance`][dhlab.text.concordance.Concordance] | ||
- [`Frequencies`][dhlab.text.frequencies.Frequencies] | ||
- [`WildcardWordSearch`][dhlab.text.wildcard.WildcardWordSearch] | ||
- [`metadata_from_urn`][dhlab.metadata.natbib.metadata_from_urn] | ||
- [`metadata_query`][dhlab.metadata.natbib.metadata_query] | ||
- [`totals`][dhlab.api.dhlab_api.totals] | ||
|
||
### Subpackages | ||
|
||
- [`api`][dhlab.api] | ||
- [`images`][dhlab.images]: Retrieve and analyze image data. | ||
- [`metadata`][dhlab.metadata]: Extract metadata on objects from the digital archive. | ||
- [`ngram`][dhlab.ngram]: Retrieve n-gram data. | ||
- [`text`][dhlab.text]: Retrieve and analyze text data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
mkdocs==1.5.2 | ||
mkdocs-autorefs==0.5.0 | ||
mkdocs-material==9.1.21 | ||
mkdocs-material-extensions==1.1.1 | ||
mkdocstrings==0.22.0 | ||
mkdocstrings-python==1.3.0 | ||
mkdocs-section-index==0.3.5 | ||
mkdocs-autorefs==0.5.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# ::: dhlab.text | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.chunking | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.collocations | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.concordance | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.corpus | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.dispersion | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.frequencies | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.utils | ||
options: | ||
show_root_heading: true | ||
|
||
## ::: dhlab.text.wildcard | ||
options: | ||
show_root_heading: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
site_name: dhlab documentation | ||
|
||
|
||
theme: | ||
name: "material" | ||
logo: _images/NB-symbol-farge.png | ||
favicon: _images/nb_symbol_farge_z5B_icon.ico | ||
palette: | ||
primary: "white" | ||
accent: "red" | ||
features: | ||
- content.code.copy | ||
- navigation.footer | ||
- navigation.path | ||
|
||
repo_url: https://github.com/NationalLibraryOfNorway/DHLAB | ||
repo_name: NationalLibraryOfNorway/DHLAB | ||
|
||
extra: | ||
social: | ||
- icon: material/home | ||
link: https://www.nb.no/ | ||
name: National Library of Norway | ||
- icon: material/book-search | ||
link: https://www.nb.no/search/ | ||
name: Online library search | ||
- icon: simple/streamlit | ||
link: https://www.nb.no/dh-lab/apper/ | ||
name: dhlab streamlit apps | ||
- icon: fontawesome/brands/github | ||
link: https://github.com/NationalLibraryOfNorway/DHLAB | ||
- icon: simple/python | ||
link: https://pypi.org/project/dhlab/ | ||
name: pypi.org | ||
- icon: material/bug | ||
link: https://github.com/NationalLibraryOfNorway/DHLAB/issues | ||
name: bug tracker | ||
|
||
plugins: | ||
- mkdocstrings | ||
- search | ||
- autorefs | ||
- section-index | ||
|
||
markdown_extensions: | ||
- admonition | ||
- pymdownx.details | ||
- pymdownx.superfences | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
line_spans: __span | ||
pygments_lang_class: true | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
- toc: | ||
permalink: true | ||
|
||
nav: | ||
- Home: index.md | ||
- Code Reference: | ||
- reference.md | ||
- api.md | ||
- images.md | ||
- metadata.md | ||
- ngram.md | ||
- text.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters