Comments (2)
Not sure what you mean exactly , but I got cross-reference working in my docstring using the TOC entry.
This part of the doc got me on the track :
https://mkdocstrings.github.io/python/
Then I managed to reference a method of separate class in docstring using
[Link Label][my_package.module.function]
Hope i'm not totally off subject and that can help
from griffe.
Thanks for helping!
Here's what I meant. In your docstrings, you can write sections to document available classes, functions or methods:
class Flags:
...
class A:
"""Class A.
Methods
-------
method_a(value)
Method a.
method_b(flag=Flags.NONE, store=False)
Method b.
"""
def method_a(self, value: str):
"""Method a."""
def method_b(self, flag: int, store: bool):
"""Method b."""
The goal here is to re-parse these signatures (method_a(value)
and method_b(flag=Flags.NONE, store=False)
), which are just text in the docstring, as Griffe expressions, which will allow the renderer to automatically add cross-references to the parameters (value
maybe, flag
and store
for sure) or values (flags.None
).
from griffe.
Related Issues (20)
- Get class parameters from parent's __init__ HOT 2
- RecursionError with Griffe, Material HOT 1
- API checks: double pass, static+dynamic analysis
- Numpy docstring for fixed set of values
- Skip Alias Resolution HOT 7
- numpydoc sections not represented as its own block, if first in docstring HOT 3
- fuzzing: Failing cases found with pysource-codegen HOT 6
- API checks: Don't report type-guarded objects HOT 4
- API checks: Improve reporting for attribute who lost their value
- Module overrides member HOT 3
- feature: Expressions modernization HOT 1
- not all members have is_package/is_module HOT 3
- class attribute has label 'instance-attribute' HOT 3
- feature: Support meson-python's editable installs
- bug: property and cached_property of dataclasses are class parameters HOT 1
- bug: A dataclass field with init=False should not be a parameter HOT 3
- bug: parameter kinds for dataclasses should match the non-dataclass equivalents
- bug: MkDocs !!! and ??? admonitions can no longer be parsed HOT 3
- bug: Regular classes that inherit dataclass do not get dataclass parameters HOT 1
- bug: A class that derives from a dataclass should be labelled a dataclass HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from griffe.