Conversation
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs failed to build...
Locally we get more information (even though we are using the same versions of packages) and the pages render...
This is caused because of the following per-file options in the
api/files...If you remove the options and just leave the reference to the API in each file, i.e.
...and add the options globally under the
mkdocstringssection ofmkdocs.yml...then you shouldn't get the deprecation warning.