Nothing Special   »   [go: up one dir, main page]

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

Add support for Sphinx format #23

Merged
merged 12 commits into from
Jul 19, 2019
Merged

Add support for Sphinx format #23

merged 12 commits into from
Jul 19, 2019

Conversation

vigoux
Copy link
Contributor
@vigoux vigoux commented Jul 19, 2019

Why this PR?

Following issue #21, this PR changes reST documentation format to support Sphinx format.
I can move all of this to a new documentation format if needed.

By contributing to DoGe you agree to the following statements:

@kkoomen kkoomen mentioned this pull request Jul 19, 2019
5 tasks
@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

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 sphinx. Make sure to follow the contribution guidelines and provide complete tests.

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: functions-doc-sphinx.vader.

I won't merge unless you have tests and the tests passed ofcourse.

@vigoux vigoux closed this Jul 19, 2019
@vigoux vigoux reopened this Jul 19, 2019
@vigoux
Copy link
Contributor Author
vigoux commented Jul 19, 2019

I added the new sphinx format and tests in functions-doc-sphinx.vader as requested.

@vigoux vigoux changed the title Change reST format to support Sphinx format Add support for Sphinx format Jul 19, 2019
Copy link
Owner
@kkoomen kkoomen left a 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:

ftplugin/python.vim Outdated Show resolved Hide resolved
ftplugin/python.vim Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
ftplugin/python.vim Outdated Show resolved Hide resolved
@kkoomen kkoomen added the feature New feature or request label Jul 19, 2019
@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

@vigoux Can you fix all of the above requested changes?

@vigoux
Copy link
Contributor Author
vigoux commented Jul 19, 2019

I think i resolved all that you wanted @kkoomen

test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
test/filetypes/python/functions-doc-sphinx.vader Outdated Show resolved Hide resolved
@kkoomen kkoomen added the good first issue Good for newcomers label Jul 19, 2019
@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

@vigoux After you've resolved the above issues you only have to add your Sphinx documentation standard to the top of the ftplugin/python.vim file. Then you're done.

ftplugin/python.vim Outdated Show resolved Hide resolved
@vigoux
Copy link
Contributor Author
vigoux commented Jul 19, 2019

I think we are done now @kkoomen !

@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

Thank you for your hard work and your co-operation. I'll release v1.5.0 immediately!

@vigoux
Copy link
Contributor Author
vigoux commented Jul 19, 2019

That was great !
I just saw that C is not supported and Rust is a project, i might look into it !

@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

I just saw that C is not supported

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.

Rust is a project, i might look into it !

Once again: if you know the ins and outs of the language along with a doc standard that's widely used, go ahead!

@kkoomen kkoomen merged commit 8bf15cc into kkoomen:master Jul 19, 2019
@kkoomen
Copy link
Owner
kkoomen commented Jul 19, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants