From 67f0e5555f024bdeca39414920b09b89e771dc2c Mon Sep 17 00:00:00 2001 From: Susana Hahn Date: Fri, 12 Sep 2025 12:13:45 -0600 Subject: [PATCH 1/3] Docs fixes --- README.md | 5 ++++- docs/getting_started.md | 20 ++++++++++---------- mkdocs.yml | 35 +++++++++++++++++------------------ 3 files changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index f4605e6..8bfc7fa 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,11 @@ fillname -h To generate and open the documentation, run ```bash -nox -s doc -- serve +mkdocs serve -o ``` +Make sure the dependencies for \[doc\] have been installed using +`pip install .[doc]` + Instructions to install and use `nox` can be found in [DEVELOPMENT.md](./DEVELOPMENT.md) diff --git a/docs/getting_started.md b/docs/getting_started.md index cf57665..96aae86 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -9,20 +9,20 @@ hide: === "Pip" -```console -pip install fillname -``` + ```console + pip install fillname + ``` === "Development mode" -```console -git clone https://github.com/potassco/fillname.git/ -cd fillname -pip install -e .[all] -``` + ```console + git clone https://github.com/potassco/fillname.git/ + cd fillname + pip install -e .[all] + ``` -!!! warning - Use only for development purposes + !!! warning + Use only for development purposes ## Usage diff --git a/mkdocs.yml b/mkdocs.yml index b6507b3..ec15967 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: fillname -site_url: https://potassco.org/systems/fillname +site_url: https://potassco.org/fillname site_description: repo_name: potassco/fillname repo_url: https://github.com/potassco/fillname @@ -100,33 +100,32 @@ plugins: handlers: python: paths: [src] - import: + inventories: - https://docs.python.org/3/objects.inv options: show_symbol_type_heading: true show_symbol_type_toc: true - # show_root_toc_entry: false - # show_inherited_summary: true - show_inherited_detail: true - show_inherited_detail_toc: true - show_inherited_detail_tree: true show_signature_annotations: true - signature_crossrefs: true show_source: false + extra: + signature_cross_references: true + show_inherited_detail: true + show_inherited_detail_toc: true + show_inherited_detail_tree: true nav: - Home: index.md - Getting Started: getting_started.md - Examples: examples/index.md - Reference: - - reference/index.md - - Problem: reference/problem/index.md - - Encodings: reference/encodings/index.md - - API: reference/api/index.md + - reference/index.md + - Problem: reference/problem/index.md + - Encodings: reference/encodings/index.md + - API: reference/api/index.md - Community: - - community/index.md - - Help: community/help.md - - Changes: community/CHANGES.md - - Contributing: community/CONTRIBUTING.md - - Development: community/DEVELOPMENT.md - - Deployment: community/DEPLOYMENT.md + - community/index.md + - Help: community/help.md + - Changes: community/CHANGES.md + - Contributing: community/CONTRIBUTING.md + - Development: community/DEVELOPMENT.md + - Deployment: community/DEPLOYMENT.md From 2f7a423950632136d89672e249d65bcda3e2d617 Mon Sep 17 00:00:00 2001 From: Susana Hahn Date: Fri, 12 Sep 2025 14:47:09 -0600 Subject: [PATCH 2/3] Update README.md Co-authored-by: Roland Kaminski --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8bfc7fa..d2a1757 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,10 @@ To generate and open the documentation, run mkdocs serve -o ``` -Make sure the dependencies for \[doc\] have been installed using -`pip install .[doc]` +Make sure to install the optional documentation dependencies via +```bash +pip install .[doc] +``` Instructions to install and use `nox` can be found in [DEVELOPMENT.md](./DEVELOPMENT.md) From 7c135b4036f828eb90dc17cd7ee8fd12ff1ef6f6 Mon Sep 17 00:00:00 2001 From: Susana Hahn Date: Fri, 12 Sep 2025 14:51:28 -0600 Subject: [PATCH 3/3] Missing new line --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d2a1757..20f2747 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ mkdocs serve -o ``` Make sure to install the optional documentation dependencies via + ```bash pip install .[doc] ```