Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modular parser for other docstring types #4

Open
arunoruto opened this issue Jul 4, 2022 · 2 comments
Open

Modular parser for other docstring types #4

arunoruto opened this issue Jul 4, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@arunoruto
Copy link

The project looks amazing and I would really like to use it, but sadly I am using numpy docstrings for my documentation. When I have time, I would love to extend the project to support numpy docstrings too, but the code is quite long and it isn't obvious how to extend it properly. Do you have tips on where to start? Maybe the parsers could be implemented in separate files and then called upon depending on what is provided in the documentation 😄

@davidenunes
Copy link
Owner

I recognize that this requires an overhaul to allow for other people to extend things more easily. I just hastily put it together for my own purposes back then 😅 Let me see if I can pull some basic dev docs together and perhaps give it an overhaul that would allow other people to extend it more easily without going beyond the scope of the project.

@davidenunes davidenunes added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 8, 2022
@SamuelMarks
Copy link

You can just use my project for this, I support numpy, Google, and ReST formats: https://github.com/offscale/cdd-python

Feel free to pip install and integrate into this project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants