Comments (5)
I eventually wrote my own mkdocs plugin, so I will not send a PR here. Got inspiration from your work so thank you. I will make sure to credit you in the readme since I stole your get_params
function 😛 (already credited in code itself).
from mkautodoc.
Wow, that's a pretty great demo gif.
Thanks 😄
It would be wonderful if the two projects could be combined, as I know
httpx
and otherencode
projects could certainly benefit from the extra easy docs.
I don't think it will be possible, or easy, or if it makes sense to combine them, because I went ahead and implemented a lot of features (and planning more, with configuration options), so it would mean a lot of (re)write for mkautodoc to match up thoses feature.
However! My code is currently badly designed (it was on purpose, to iterate quickly and see what was possible), and ideally would be refactored as a plugin+extension combo, so mkdocstrings, which is a plugin only right now, would totally benefit from stealing more from mkautodoc. I also gladly accept contributions of course.
For more information on the immediate future of mkdocstrings, see the refactor issue and the related mkdocs issue.
from mkautodoc.
Nope. I guess we might consider a pull request for it, but it's otherwise not a priority for me right now.
from mkautodoc.
I'll try to open a PR later then 🙂 At first sight it seems like it would not be too complicated. The AutoDocProcessor.RE
regexp is OK. I think import_from_string
will need an update, as well as AutoDocProcessor.run
to prevent trying to render a signature for a module.
from mkautodoc.
Wow, that's a pretty great demo gif. It would be wonderful if the two projects could be combined, as I know httpx
and other encode
projects could certainly benefit from the extra easy docs.
from mkautodoc.
Related Issues (18)
- Question: must docstrings be written in markdown? HOT 1
- Support references HOT 1
- Table rendering HOT 19
- Integration with a django project HOT 6
- TOC from rendered docs?
- Docstrings aren't rendered at all HOT 1
- :members: : select all, except the one specified HOT 2
- Feature: Format using Sphinx docstring format HOT 2
- Mock imports HOT 1
- Support for different docstring styles? HOT 1
- Which docstring style is supported? HOT 1
- Docstring format supported ? HOT 2
- mkautodoc does not support trio library
- Incompatible with prettier. HOT 1
- Please clarify copyright and licence HOT 2
- Incompatible with markdown >=3.4
- Failed to load extension 'mkautodoc' HOT 1
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 mkautodoc.