docs: configure mkdocs to work

NationalLibraryOfNorway · Mar 6, 2024 · ee29bbc · ee29bbc
1 parent 7fbd893
commit ee29bbc
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 12 deletions.
diff --git a/docs/index.md → docs/index_home.md b/docs/index.md → docs/index_home.md
@@ -24,3 +24,4 @@ Install the latest version of the [`dhlab`](https://pypi.org/project/dhlab/) pyt
 pip install -U dhlab
 ```
 <!-- end installation -->
+
diff --git a/docs/reference.md b/docs/reference.md
@@ -1,7 +1,6 @@
 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
@@ -17,9 +16,9 @@ that can be imported directly from `dhlab.*`, for example: `from dhlab import Co
 - [`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]
+- [`Collocations`][dhlab.text.conc_coll.Collocations]
+- [`Concordance`][dhlab.text.conc_coll.Concordance]
+- [`Counts`][dhlab.text.conc_coll.Counts]
 - [`WildcardWordSearch`][dhlab.text.wildcard.WildcardWordSearch]
 - [`metadata_from_urn`][dhlab.metadata.natbib.metadata_from_urn]
 - [`metadata_query`][dhlab.metadata.natbib.metadata_query]

diff --git a/docs/text.md b/docs/text.md
@@ -1,35 +1,44 @@
 # ::: dhlab.text
+
     options:
       show_root_heading: true
 
-## ::: dhlab.text.chunking
+## ::: dhlab.text.corpus
+
     options:
       show_root_heading: true
 
-## ::: dhlab.text.collocations
+## ::: dhlab.text.conc_coll.Counts
+
     options:
       show_root_heading: true
 
-## ::: dhlab.text.concordance
+## ::: dhlab.text.conc_coll.Concordance
+
     options:
       show_root_heading: true
 
-## ::: dhlab.text.corpus
+## ::: dhlab.text.conc_coll.Collocations
+
     options:
-      show_root_heading: true
+      	show_root_heading: true
+
+## ::: dhlab.text.chunking
 
-## ::: dhlab.text.dispersion
     options:
       show_root_heading: true
 
-## ::: dhlab.text.frequencies
+## ::: dhlab.text.dispersion
+
     options:
       show_root_heading: true
 
 ## ::: dhlab.text.utils
+
     options:
       show_root_heading: true
 
 ## ::: dhlab.text.wildcard
+
     options:
       show_root_heading: true
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -54,9 +54,12 @@ markdown_extensions:
   - pymdownx.snippets
   - toc:
       permalink: true
+      baselevel: 2
 
 nav:
-  - Home: index.md
+  - Home: index_home.md
+  - Examples: docs_example_use.md
+  - Terms: term_definitions.md
   - Code Reference:
     - reference.md
     - api.md