Comments (2)
This feels more like a hack than anything else, but given that it's in PEP 484 I'd be happy to merge a PR that adds support for it. Fwiw, a strict reading of the spec seems to imply this only applies to stub files of I'm not mistaken...
As a workaround, I'd recommend to just declare __all__
.
from pdoc.
This feels more like a hack than anything else
tell me about it, that's python typing for you lol
a strict reading of the spec seems to imply this only applies to stub files of I'm not mistaken...
yeah i don't know why but for some reason most of the documentation and discussions around python typing seems to imply that you'd only ever use types in stubs and not actual source code. but the two main type checkers support this explicit re-export "syntax" outside of stubs (mypy and pyright) so i think it's safe to assume this behavior is intended to work in regular source code too
As a workaround, I'd recommend to just declare
__all__
.
thanks. though i'm not really a fan of __all__
since it would mean i have to add everything else in my module to it, and i prefer declaring whether something is public/private on its definition rather than in a separate section of the module. so the workaround i went with was to just import it and assign it to another variable:
# foo/public_module.py
from _private_module import foo as _foo
foo = _foo
"""the downside is that i have to move the docstring here tho"""
from pdoc.
Related Issues (20)
- add --dunder flag to include documentation for double-underscore methods
- `TYPE_CHECKING` warnings when used with Pydantic models HOT 1
- "View Source" button for @property, @cached_property methods HOT 8
- source_file not extracted for cached function
- Multiple reference duplication when loading docstring of function HOT 1
- [Question] Is there any way to prevent pdoc from documenting method objects? HOT 5
- 🙏 HOT 1
- support the `@deprecated` decorator HOT 1
- Link is not working when class is included in `__all__`
- Fails without error in CI for certain import statements HOT 5
- Add `overflow-y: hidden;` to css style `mjx-container` HOT 1
- Error parsing annotation: 'type' object is not subscriptable HOT 2
- Error importing module: no signature found for builtin type `<class 'type I wrote'>` HOT 3
- Proposal: Document each member at the lowest-level submodule, with higher level modules pointing at submodule's primary declaration without duplicating them. HOT 2
- TypeError in /pdoc/extract.py HOT 2
- add pre-commit support HOT 1
- Support `start-after` option for `.. include::` directive HOT 1
- Way to add external Markdown file HOT 2
- A way to NOT inherit documentation for a specific class HOT 4
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 pdoc.