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

Feature/add rst #169

Merged
merged 6 commits into from
Dec 15, 2020
Merged

Conversation

sam-hoffman
Copy link
Contributor

This PR adds a template for one-line RST, which is automatically parsed by Sphinx and much more human readable than traditional RST. This is similar to #163 , but I hope more comprehensive.

It also fixes a minor typo in test/docstring/get_template.spec.ts.

@sam-hoffman
Copy link
Contributor Author

hey @NilsJPWerner , wanted to bring this up again to see if i could get a review, pretty please :)

@@ -8,6 +8,8 @@ export function getTemplate(docstringFormat: string): string {
return getTemplateFile("sphinx.mustache");
case "numpy":
return getTemplateFile("numpy.mustache");
case "oneline-rst":
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation still looks weird

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be fixed now, sorry about that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants