Update documentation build metadata

collijk · Dec 27, 2023 · 1b75fa1 · 1b75fa1
1 parent 7de778c
commit 1b75fa1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md
@@ -48,7 +48,7 @@ pytest
 
 ### Documentation
 
-The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
+The documentation is automatically generated from the content of the `docs` directory and from the docstrings
  of the public signatures of the source code. The documentation is updated and published as a [Github project page
  ](https://pages.github.com/) automatically as part each release.
 

diff --git a/{{cookiecutter.project_slug}}/mkdocs.yml b/{{cookiecutter.project_slug}}/mkdocs.yml
@@ -18,6 +18,9 @@ nav:
   - api_docs.md
   - changelog.md
 
+watch:
+  - src/{{ cookiecutter.package_name }}
+
 markdown_extensions:
   - abbr
   - admonition
@@ -56,18 +59,17 @@ markdown_extensions:
   - tables
 
 plugins:
-  - table-reader:
-  - search:
+  - table-reader
+  - search
   - mkdocstrings:
       default_handler: python
       handlers:
         python:
-          rendering:
+          paths: [src]
+          options:
             show_signature_annotations: true
-            show_source: true
             show_submodules: true
-      watch:
-        - src/{{ cookiecutter.package_name }}
+
 
 extra_javascript:
   - https://unpkg.com/[email protected]/dist/tablesort.min.js