-
-
Notifications
You must be signed in to change notification settings - Fork 50
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
Add support for Sphinx format #23
Conversation
Looking at this http://daouzli.com/blog/docstring.html#restructuredtext it mentions that both are supported. The current version is just an abbreviated version which personally I have seen the most through open source projects. We can support your version, but then I definitely want this to be a separate doc standard named I can do this as well since I'm fast in doing the tests. If you want to do it yourself I suggest copying over the Google doc standard tests and copying this to: I won't merge unless you have tests and the tests passed ofcourse. |
I added the new |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure to add your Sphinx doc standard to ftplugin/python.vim
at the top of the file. Make sure to pull from master again, since I just added the missing Google doc.
EDIT:
- Add your doc standard to the Supported languages and doc standards section.
- Add your new doc standard to the Choosing a different doc standard section.
@vigoux Can you fix all of the above requested changes? |
I think i resolved all that you wanted @kkoomen |
@vigoux After you've resolved the above issues you only have to add your Sphinx documentation standard to the top of the |
I think we are done now @kkoomen ! |
Thank you for your hard work and your co-operation. I'll release v1.5.0 immediately! |
That was great ! |
If you want to support C and know the ins and outs of the language, go ahead. It's on my list, but haven't made the time to add it. It hasn't been requested yet, but I do want to support it. I suggest you use the Doxygen documentation guidelines since this is the most commonly used doc standard for C. Use the contribution guidelines since adding a language takes some time. You can use the C++ ftplugin and tests as a base.
Once again: if you know the ins and outs of the language along with a doc standard that's widely used, go ahead! |
Your contribution has been released as v1.5.0. Feel free to submit any new issues if you experience any unwanted behaviour in the future. Thanks for your contribution. |
Why this PR?
Following issue #21, this PR changes
reST
documentation format to supportSphinx
format.I can move all of this to a new documentation format if needed.
By contributing to DoGe you agree to the following statements: