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 defintion lists #153

Closed
chrisjsewell opened this issue May 31, 2020 · 3 comments
Closed

Add support for defintion lists #153

chrisjsewell opened this issue May 31, 2020 · 3 comments
Labels
enhancement New feature or request syntax descisions on syntax formats

Comments

@chrisjsewell
Copy link
Member

Basically implement https://github.com/markdown-it/markdown-it-deflist in markdown-it-py then allow the extension to be (optionally?) loaded in

@dhermes
Copy link
Contributor

dhermes commented Aug 31, 2020

@chrisjsewell Per our discussion on #163, here is an example of a directive I'm drafting for a Go method:

```{go:method} ApplyMigration
:file: manager.go
:line-number: 137
:receiver: *Manager
:param-name 0: ctx
:param-type 0: context.Context
:param-name 1: migration
:param-type 1: Migration
:return-name 0: err
:return-type 0: error

ApplyMigration creates a transaction that runs the "Up" migration.
```

(I'm open to other variants of the param-* / return-* approach. It just needs to be flexible enough to have named and unnamed values in a signature and the actual type can be quite complex. Also, unlike Python or other languages there is no Go convention (yet) for documenting individual parameters so this is strictly a mapping to name/type expression, in order.)

@pradyunsg
Copy link
Member

pradyunsg commented Sep 28, 2020

@chrisjsewell
Copy link
Member Author

yep 👍 I would note though that what @dhermes above is after is a field list markodown-it plugin + render method, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists

so I'll close this one, but if you want to open a new issue about that, by all means go ahead (I thought there already was one, but apparently not)

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

No branches or pull requests

3 participants