Skip to content

Conversation

@ns-rse
Copy link
Collaborator

@ns-rse ns-rse commented Jan 14, 2026

Docs failed to build...

WARNING -  Config value 'plugins': Plugin 'mike' option 'version': Unrecognised configuration name: version
INFO    -  MERMAID2  - Initialization arguments: {}
INFO    -  MERMAID2  - Using javascript library (10.4.0):
   https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/runner/work/AFMReader/AFMReader/site
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - api.md
ERROR   -  Error reading page 'api/asd.md':
ERROR   -  Invalid options: PythonOptions.__init__() got an unexpected keyword argument 'rendering'

Aborted with a BuildError!
Error: Process completed with exit code 1.

Locally we get more information (even though we are using the same versions of packages) and the pages render...

INFO    -  DeprecationWarning: Passing extra options directly under `options` is deprecated. Instead, pass them under `options.extra`, and update your templates. Current extra (unrecognized) options: rendering

This is caused because of the following per-file options in the api/ files...

::: AFMReader.topostats
   handler: python
   options:
       docstring_style: numpy
       rendering:
           show_signature_annotations: true

If you remove the options and just leave the reference to the API in each file, i.e.

::: AFMReader.topostats

...and add the options globally under the mkdocstrings section of mkdocs.yml

plugins:
  ...
  - mkdocstrings:
      handlers:
       python:
         options:
           docstring_style: numpy
           show_signature_annotations: true

...then you shouldn't get the deprecation warning.

Docs [failed to build](https://github.com/AFM-SPM/AFMReader/actions/runs/20993404833/job/60344982776)...

```
WARNING -  Config value 'plugins': Plugin 'mike' option 'version': Unrecognised configuration name: version
INFO    -  MERMAID2  - Initialization arguments: {}
INFO    -  MERMAID2  - Using javascript library (10.4.0):
   https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/runner/work/AFMReader/AFMReader/site
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - api.md
ERROR   -  Error reading page 'api/asd.md':
ERROR   -  Invalid options: PythonOptions.__init__() got an unexpected keyword argument 'rendering'

Aborted with a BuildError!
Error: Process completed with exit code 1.
```

Locally we get more information (even though we are using the same versions of packages) and the pages render...

```
INFO    -  DeprecationWarning: Passing extra options directly under `options` is deprecated. Instead, pass them under `options.extra`, and update your templates. Current extra (unrecognized) options: rendering
```

This is caused because of the following per-file options in the `api/` files...

```
::: AFMReader.topostats
   handler: python
   options:
       docstring_style: numpy
       rendering:
           show_signature_annotations: true
```

If you remove the options and just leave the reference to the API in each file, i.e.

```
::: AFMReader.topostats
```

...and add the options globally under the `mkdocstrings` section of `mkdocs.yml`

```
plugins:
  ...
  - mkdocstrings:
      handlers:
       python:
         options:
           docstring_style: numpy
           show_signature_annotations: true
```

...then you shouldn't get the deprecation warning.
@ns-rse ns-rse requested a review from SylviaWhittle January 14, 2026 13:19
@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.84%. Comparing base (ac9753c) to head (d65d297).
⚠️ Report is 238 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #183      +/-   ##
==========================================
+ Coverage   74.62%   79.84%   +5.21%     
==========================================
  Files           8       12       +4     
  Lines         607      928     +321     
==========================================
+ Hits          453      741     +288     
- Misses        154      187      +33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ns-rse ns-rse merged commit 62e9502 into main Jan 14, 2026
12 checks passed
@ns-rse ns-rse deleted the ns-rse/fix-mkdocs branch January 14, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants